-
Notifications
You must be signed in to change notification settings - Fork 0
fix(serverless): describe env and secret changes as workload rolls #124
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -96,7 +96,12 @@ func newSecretsSetCmd(logger *log.Logger) *cobra.Command { | |
| Short: "Create or update an organisation secret", | ||
| Long: `Create an organisation-scoped secret, or update its value if the name already exists. | ||
|
|
||
| This does not attach the secret to an application. Use 'secrets attach' for that. | ||
| Creating a secret does not attach it to an application. Use 'secrets attach' for that. | ||
| Updating an existing secret re-encrypts the value and rolls every live application | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. suggestion (non-blocking): Use one term for each concept across env and secrets: "rolls the workload" or "rolls the live deployment", and "app" or "application". Also define "live", because the env help lists statuses and the secrets help does not. |
||
| that attaches it, so a running worker picks up the new value. If a rollout is already | ||
| in progress, the new value reaches that worker on the next deploy. An application | ||
| that is not live picks it up on its next deploy. | ||
|
|
||
| The secret value is never printed. Prefer --value-file so the value is not visible | ||
| in process lists; use --value-file - to read from stdin.`, | ||
| Example: ` # create or update a secret from a file | ||
|
|
@@ -223,8 +228,11 @@ func newSecretsAttachCmd(logger *log.Logger) *cobra.Command { | |
| Long: `Record that an organisation secret is attached to an application, optionally | ||
| under a different environment variable name. | ||
|
|
||
| The organisation secret must already exist (see 'secrets set'). This is a | ||
| control-plane association only in this API release — it does not roll workers.`, | ||
| The organisation secret must already exist (see 'secrets set'). Attaching rolls | ||
| the live deployment so a running worker picks up the value. If a rollout is | ||
| already in progress, this attach reaches the worker on the next deploy. An | ||
| application that is not live records the attachment only; the next deploy or | ||
| resume reads it.`, | ||
| Example: ` # attach a secret using its name as the env var | ||
| runware serverless secrets attach my-app FOO | ||
|
|
||
|
|
@@ -265,8 +273,12 @@ func newSecretsDetachCmd(logger *log.Logger) *cobra.Command { | |
| cmd := &cobra.Command{ | ||
| Use: "detach <appId> <name>", | ||
| Short: "Detach a secret from an application", | ||
| Long: `Remove the control-plane attachment from an application. Does not remove the | ||
| organisation secret.`, | ||
| Long: `Remove an organisation secret's attachment from an application. The organisation | ||
| secret itself remains. | ||
|
|
||
| Detaching rolls the live deployment so a running worker stops receiving the | ||
| value. If a rollout is already in progress, the worker stops receiving it on | ||
| the next deploy. An application that is not live records the removal only.`, | ||
| Example: ` # detach a secret from an application | ||
| runware serverless secrets detach my-app FOO`, | ||
| Args: cobra.ExactArgs(2), | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion (non-blocking): The same rollout paragraph appears in
apps env set,apps env unsetanddeploy. Put it in one shared const, or makedeployrefer toapps env set --help.