update secret registry readme#1034
Conversation
Signed-off-by: Marjan Alavi <malavi@vmware.com>
79b2c93 to
020b3bb
Compare
| ```sh | ||
| kubectl create namespace <NAMESPACE> | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Here we are mentioning 2 & 3 separately(only one way).
We can start by saying there are 2 ways of adding/exporting a secret after Step 1:
- 2& 3 separately ( where 2 adds secret and 3 updates secret by exporting to a diff namespace)
or
specify a single one line command for doing adding/exporting together
cmd/cli/plugin/secret/README.md
Outdated
| 3. In case you want to add the private repository in a different namespace than the namespace in which the secret was added to, you need o export the secret to all other namespaces. Please be aware that by doing so, the given secret contents will be available to ALL users in ALL namespaces. Please ensure that included registry credentials allow only read-only access to the registry with minimal necessary scope. You can export the secret to other namespaces by running: | ||
|
|
||
| ```sh | ||
| tanzu secret registry update <SECRET-NAME> --namespace <SECRET-NAMESPACE> --export-to-all-namespaces=true -y |
There was a problem hiding this comment.
It would be nice to have the sample output of commands.When the doc writers try it out, they know they are going on right track by comparing the output
|
Since in README , we have the topic heading which says "Workflow for adding a private package repository and installation of a private package", we should probably use something like below for release notes |
24a557b to
5038fb4
Compare
cmd/cli/plugin/secret/README.md
Outdated
| Added registry secret '<SECRET-NAME>' into namespace '<SECRET-NAMESPACE>' | ||
| ``` | ||
|
|
||
| 3. In case you want to add the private repository in a different namespace than the namespace in which the secret was added to, you need o export the secret to all other namespaces. Please be aware that by doing so, the given secret contents will be available to ALL users in ALL namespaces. Please ensure that included registry credentials allow only read-only access to the registry with minimal necessary scope. You can export the secret to other namespaces using one of the followings: |
There was a problem hiding this comment.
nitpick: followings => following
Signed-off-by: Marjan Alavi <malavi@vmware.com>
5038fb4 to
bd45b36
Compare
What this PR does / why we need it:
Describe testing done for PR:
Not applicable
Does this PR introduce a user-facing change?:
None
Release note:
New PR Checklist