diff --git a/charts/s1-agent/README.md b/charts/s1-agent/README.md index d0606d8..cc19c95 100644 --- a/charts/s1-agent/README.md +++ b/charts/s1-agent/README.md @@ -4,28 +4,30 @@ ### Prerequisites -_When using your own image registry:_ - -* Push images to your registry and tag with the correct tag +Push images to your registry and tag with the correct tag In every case: * Create a namespace to deploy to; e.g. `kubectl create namespace sentinelone` -* Create an image pull secret to pull the images from the registry, if the cluster does not have access to the repository already. This does apply when you are using S1's container registry. +* Create an image pull secret to pull the images from the registry, if the cluster does not have access to the repository already. E.g., to create an image pull secret called `s1-github-access`: ``` - kubectl create secret --namespace sentinelone docker-registry s1-github-access --docker-username=s1customer --docker-password= + kubectl create secret --namespace sentinelone docker-registry s1-github-access --docker-username= --docker-password= ``` ### Perform install -* Install or upgrade the agent using the helm chart (`name`=the name you want to use for this deployment): +* Install or upgrade the agent using the helm chart (`release_name`= the release name for this deployment): ``` - helm upgrade --install \ + helm upgrade --install \ --namespace= \ --set configuration.cluster.name= \ --set secrets.imagePullSecret= \ + --set configuration.repositories.agent= \ + --set configuration.tag.agent= \ + --set configuration.repositories.helper= \ + --set configuration.tag.helper= \ --set secrets.site_key.value= ``` @@ -33,32 +35,49 @@ In every case: ### A console with a private CA issued certificate -* Set `configuration.custom_ca` to `true` (e.g. `-- set configuration.custom_ca=true`, or edit your `values.yaml`) +* Set `configuration.custom_ca` to `true` (e.g. `--set configuration.custom_ca=true`, or edit your `values.yaml`) * Copy your CA certificate to `files/ca.pem` (from the root of the chart directory) ## Other Operations ### Dry run: Create yamls without installing them using dry run command ``` -helm install --namespace= --dry-run --debug +helm install --namespace= --dry-run --debug ``` ### Uninstall ``` -helm uninstall --namespace= +helm uninstall --namespace= ``` ### Upgrade +helm upgrade command: +``` + helm upgrade --install \ + --namespace= \ + --set configuration.cluster.name= \ + --set secrets.imagePullSecret= \ + --set configuration.repositories.agent= \ + --set configuration.tag.agent= \ + --set configuration.repositories.helper= \ + --set configuration.tag.helper= \ + --set secrets.site_key.value= +``` +To reuse values: ``` -helm upgrade + helm get values -n -o yaml > deployed_values.yaml + helm upgrade --install --namespace= -f deployed_values.yaml \ + --set configuration.tag.agent= \ + --set configuration.tag.helper= \ + ``` ### Rollback ``` -helm rollback --namespace= 1 +helm rollback --namespace= ``` ### History ``` -helm history --namepsace= +helm history --namepsace= ``` \ No newline at end of file