chore(docs): fix inconsistencies in external provisioner docs #15416
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nal provisioner docs
johnstcn
commented
Nov 6, 2024
Comment on lines
-306
to
-321
| 1. Modify your Coder `values.yaml` to include | ||
|
|
||
| ```yaml | ||
| provisionerDaemon: | ||
| keySecretName: "coder-provisioner-keys" | ||
| keySecretKey: "key1" | ||
| ``` | ||
|
|
||
| 1. Redeploy Coder with the new `values.yaml` to roll out the PSK. You can omit | ||
| `--version <your version>` to also upgrade Coder to the latest version. | ||
|
|
||
| ```sh | ||
| helm upgrade coder coder-v2/coder \ | ||
| --namespace coder \ | ||
| --version <your version> \ | ||
| --values values.yaml |
There was a problem hiding this comment.
review: this is no longer required when using provisioner keys, removed.
johnstcn
commented
Nov 6, 2024
| @@ -331,13 +315,17 @@ will use in concert with the Helm chart for deploying the Coder server. | |||
| value: "https://coder.example.com" | |||
| replicaCount: 10 | |||
| provisionerDaemon: | |||
| # NOTE: in older versions of the Helm chart, it is required to set this to an empty string. | |||
| pskSecretName: "" | |||
There was a problem hiding this comment.
review: PR to address this workaround is here: #15417
johnstcn
commented
Nov 6, 2024
| @@ -288,8 +291,7 @@ will use in concert with the Helm chart for deploying the Coder server. | |||
| ```sh | |||
| coder provisioner keys create my-cool-key --org default | |||
| # Optionally, you can specify tags for the provisioner key: | |||
| # coder provisioner keys create my-cool-key --org default --tags location=auh kind=k8s | |||
There was a problem hiding this comment.
review: --tags is incorrect -> --tag A --tag B
bpmct
approved these changes
Nov 6, 2024
johnstcn
added a commit
that referenced
this pull request
Nov 7, 2024
… set (#15417) Relates to #15416 This PR modifies the provisioner helm chart logic: - Previously, when both provisionerDaemon.keySecretName and provisionerDaemon.pskSecretName were both set, we would fail to install the chart. This required users to have an obnoxious workaround in place where setting provisionerDaemon.pskSecretName="" was required in order to use provisioner keys. We now check for pskSecretName being set to the default value when keySecretName is also specified, and switch to provisioner key authentication instead of PSK. The previous workaround is still supported. - We also had omitted to check for provisionerd.Tags being set along with provisionerDaemon.keySecretName. This would result in a crashlooping provisioner deployment, as setting both of these configuration options is not allowed. We now fast-fail the Helm deployment if we detect this scenario.
bpmct
reviewed
Nov 7, 2024
Open
9 tasks
bpmct
pushed a commit
that referenced
this pull request
Nov 8, 2024
… set (#15417) Relates to #15416 This PR modifies the provisioner helm chart logic: - Previously, when both provisionerDaemon.keySecretName and provisionerDaemon.pskSecretName were both set, we would fail to install the chart. This required users to have an obnoxious workaround in place where setting provisionerDaemon.pskSecretName="" was required in order to use provisioner keys. We now check for pskSecretName being set to the default value when keySecretName is also specified, and switch to provisioner key authentication instead of PSK. The previous workaround is still supported. - We also had omitted to check for provisionerd.Tags being set along with provisionerDaemon.keySecretName. This would result in a crashlooping provisioner deployment, as setting both of these configuration options is not allowed. We now fast-fail the Helm deployment if we detect this scenario. (cherry picked from commit 6781b0f)
bpmct
added a commit
that referenced
this pull request
Nov 8, 2024
This PR: - Updates the table in `docs/admin/provisioners.md` to include highlight multi-org changes - Updates the instructions for the provisionerd helm chart when using provisioner keys --------- Co-authored-by: Ben Potter <ben@coder.com> (cherry picked from commit 9f05b19)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR:
docs/admin/provisioners.mdto include highlight multi-org changes