Carvel package readme updates

This commit is contained in:
Benjamin A. Petersen 2023-10-20 14:49:16 -04:00
parent 8dfac21eb8
commit d5565af1d3
No known key found for this signature in database
GPG Key ID: EF6EF83523A4BE46
4 changed files with 43 additions and 3 deletions

10
deploy_carvel/README.md Normal file
View File

@ -0,0 +1,10 @@
# Deployment via Carvel Packages
The Carvel Package deployment method can be exercised via the following invocation:
```bash
PINNIPED_USE_LOCAL_KIND_REGISTRY=1 ./hack/prepare-for-integration-tests.sh \
--clean \
--alternate-deploy ./hack/noop.sh \
--post-install ./hack/build-carvel-packages.sh
```

View File

@ -2,6 +2,15 @@
See [the how-to guide for details](https://pinniped.dev/docs/howto/concierge/).
The Carvel Package deployment method can be exercised via the following invocation:
```bash
PINNIPED_USE_LOCAL_KIND_REGISTRY=1 ./hack/prepare-for-integration-tests.sh \
--clean \
--alternate-deploy ./hack/noop.sh \
--post-install ./hack/build-carvel-packages.sh
```
## In this directory:
- the ./config symlink points to <root>/deploy/concierge
- `vendir` is used to copy the <root>/deploy/concierge ytt files to <root>/deploy_carvel/concierge/config.

View File

@ -1,5 +1,17 @@
# local-user-authenticator
The local-user-authenticator is a component used for testing Pinniped and is not a production component.
See [Application main functions](https://pinniped.dev/docs/reference/code-walkthrough/#application-main-functions) for a brief description.
The Carvel Package deployment method can be exercised via the following invocation:
```bash
PINNIPED_USE_LOCAL_KIND_REGISTRY=1 ./hack/prepare-for-integration-tests.sh \
--clean \
--alternate-deploy ./hack/noop.sh \
--post-install ./hack/build-carvel-packages.sh
```
## In this directory:
- the ./config symlink points to <root>/deploy/local-user-authenticator
- `vendir` is used to copy the <root>/deploy/local-user-authenticator ytt files to <root>/deploy_carvel/local-user-authenticator/config.

View File

@ -2,6 +2,15 @@
See [the how-to guide for details](https://pinniped.dev/docs/howto/install-supervisor/).
The Carvel Package deployment method can be exercised via the following invocation:
```bash
PINNIPED_USE_LOCAL_KIND_REGISTRY=1 ./hack/prepare-for-integration-tests.sh \
--clean \
--alternate-deploy ./hack/noop.sh \
--post-install ./hack/build-carvel-packages.sh
```
## In this directory:
- the ./config symlink points to <root>/deploy/supervisor
- `vendir` is used to copy the <root>/deploy/supervisor ytt files to <root>/deploy_carvel/supervisor/config.