Skip to content
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

docs: Update the kpt book with more details about namespaces and RBAC for porch #3692

Merged
merged 1 commit into from
Dec 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ using Porch. You will need:
the `repo` scope for Porch to authenticate with the repository and allow it
to create commits in the repository.

A repository is a porch representation of either a git repo or an oci registry.
Package revisions always belong to a single repository. A repository exists in
a Kubernetes namespace and all package revisions in a repo also belong to
the same namespace.

Use the `kpt alpha repo register` command to register your repository with
Porch: The command below uses the repository `deployments.git`.
Your repository name may be different; please update the command with the
Expand Down
7 changes: 7 additions & 0 deletions site/book/08-package-orchestration/04-package-authoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,13 @@ You can find out more about the `upstream` and `upstreamLock` sections of the
`Kptfile` in an [earlier chapter](/book/03-packages/01-getting-a-package)
of the book.

> A cloned package must be created in a repository in the same namespace as
> the source package. Cloning a package with the Package Orchestration Service
> retains a reference to the upstream package revision in the clone, and
> cross-namespace references are not allowed. Package revisions in repositories
> in other namespaces can be cloned using a reference directly to the underlying
> oci or git repository as described below.

You can also clone a package from a repository that is _not_ registered with
Porch, for example:

Expand Down
4 changes: 4 additions & 0 deletions site/book/08-package-orchestration/05-package-lifecycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ deployments-8baf4892d6bdeda0f26ef4b1088fddb85c5a2486 rejected
?> Refer to the [approve][rpkg-approve] and [reject][rpkg-reject] command
reference for usage.

> Approving a package revisions requires that the current user has been granted
> update access to the `approve` subresource of `packagerevisions`. This allows
> for giving only a limited set of users permission to approve package revisions.

Now, confirm lifecycle stages of the package revisions:

```sh
Expand Down