Skip to content
This repository was archived by the owner on Oct 10, 2023. It is now read-only.

update secret registry readme#1034

Merged
maralavi merged 2 commits intovmware-tanzu:mainfrom
maralavi:update-secret-registry-readme
Nov 4, 2021
Merged

update secret registry readme#1034
maralavi merged 2 commits intovmware-tanzu:mainfrom
maralavi:update-secret-registry-readme

Conversation

@maralavi
Copy link
Copy Markdown
Contributor

@maralavi maralavi commented Nov 1, 2021

What this PR does / why we need it:

  • This PR is to update secret registry README to add the workflow for adding a private package repository and a installation of a private package

Describe testing done for PR:
Not applicable

Does this PR introduce a user-facing change?:
None

Release note:

updates secret registry README to add the workflow for adding a private package repository using package and secret plugins

New PR Checklist

  • Ensure PR contains only public links or terms
  • Use good commit messages
  • Squash the commits in this branch before merge to preserve our git history
  • If this PR is just an idea or POC, use a Draft PR instead of a full PR
  • Add appropriate kind label according to what type of issue is being addressed.

@maralavi maralavi requested a review from a team as a code owner November 1, 2021 23:01
@maralavi maralavi requested a review from a team November 1, 2021 23:01
Signed-off-by: Marjan Alavi <malavi@vmware.com>
@maralavi maralavi force-pushed the update-secret-registry-readme branch from 79b2c93 to 020b3bb Compare November 1, 2021 23:06
```sh
kubectl create namespace <NAMESPACE>
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  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

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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@shivaani0505
Copy link
Copy Markdown
Contributor

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
"updates secret registry README to add the workflow for adding a private package repository using package and secret plugins"

@maralavi maralavi force-pushed the update-secret-registry-readme branch from 24a557b to 5038fb4 Compare November 3, 2021 19:32
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:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: o -> to

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: followings => following

Signed-off-by: Marjan Alavi <malavi@vmware.com>
@maralavi maralavi force-pushed the update-secret-registry-readme branch from 5038fb4 to bd45b36 Compare November 4, 2021 00:25
Copy link
Copy Markdown
Contributor

@shivaani0505 shivaani0505 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@shivaani0505 shivaani0505 added the ok-to-merge PRs should be labelled with this before merging label Nov 4, 2021
@maralavi maralavi merged commit e32cab8 into vmware-tanzu:main Nov 4, 2021
@maralavi maralavi deleted the update-secret-registry-readme branch November 4, 2021 17:47
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cla-not-required ok-to-merge PRs should be labelled with this before merging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants