Skip to content

Commit 651901f

Browse files
committed
add the --values flag
1 parent 2b3870c commit 651901f

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

platform/_partials/cluster/connect-helm.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,5 +88,14 @@ import Expander from '@site/src/components/Expander'
8888
8989
This command automatically installs the [vCluster Platform Agent](/docs/platform/administer/clusters/advanced/agent-config) in the cluster that is your current context.
9090
However, if you want to connect a cluster that is not your current context, you can append the `--kube-context` flag to specify the context of the cluster you want to connect.
91+
92+
You can also retrieve pre-configured agent values from your platform by appending the `--values` flag with the platform endpoint `--values "https://$HOST/clusters/agent-values/$CLUSTER_NAME?token=$TOKEN"`.
93+
- `$HOST` — your vCluster Platform domain
94+
- `$CLUSTER_NAME` — the name you're assigning to the cluster being connected (e.g., `cluster-name`)
95+
- `$TOKEN` — the authentication token to access your vCluster Platform
96+
The endpoint returns an intelligently merged content of
97+
- Platform-level defaults configured in the `agentValues` field of your vCluster Platform Helm values
98+
- Cluster-specific overrides from the `loft.sh/agent-values` annotation (when present)
99+
91100
</Step>
92101
</Flow>

platform/_partials/cluster/upgrade-helm.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,15 @@ import Expander from '@site/src/components/Expander'
4444
Ensure that the namespace specified with `--namespace` exists. This is the namespace where the platform agent is installed.
4545
If you deploy the platform agent’s resources into a different namespace, make sure to set `--namespace` accordingly.
4646

47+
You can also retrieve pre-configured agent values from your platform by appending the `--values` flag with platform endpoint
48+
`--values "https://$HOST/clusters/agent-values/$CLUSTER_NAME?token=$TOKEN"`.
49+
- `$HOST` your platform domain.
50+
- `$CLUSTER_NAME` the name of the cluster you are connecting.
51+
- `$TOKEN` the authentication token.
52+
In this example, `$HOST=loftg2fei.loft.host`, `$CLUSTER_NAME=cluster-name` and `$TOKEN=xxxxxxxx`.
53+
The endpoint returns a YAML file with agent values that are configured in the `agentValues` field of your vCluster
54+
Platform Helm values, merged with any cluster-specific overrides from the `loft.sh/agent-values` annotation (when present).
55+
4756
If the platform agent is not yet installed, you can include the `--install` and `--create-namespace` flags. The combination
4857
of `--create-namespace` and `--namespace vcluster-platform` will create the `vcluster-platform` namespace in the host cluster
4958
if it does not already exist. All platform agent resources will then be deployed and run within that namespace.

0 commit comments

Comments
 (0)