Clean up docs using https://get.pinniped.dev redirects.
We have these redirects set up to make the `kubectl apply -f [...]` commands cleaner, but we never went back and fixed up the documentation to use them until now. Signed-off-by: Matt Moyer <moyerm@vmware.com>
This commit is contained in:
parent
1b224bc4f2
commit
1ceef5874e
@ -10,17 +10,17 @@ for details.
|
|||||||
## Installing the Latest Version with Default Options
|
## Installing the Latest Version with Default Options
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/$(curl https://api.github.com/repos/vmware-tanzu/pinniped/releases/latest -s | jq .name -r)/install-pinniped-concierge.yaml
|
kubectl apply -f https://get.pinniped.dev/latest/install-pinniped-concierge.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installing an Older Version with Default Options
|
## Installing a Specific Version with Default Options
|
||||||
|
|
||||||
Choose your preferred [release](https://github.com/vmware-tanzu/pinniped/releases) version number
|
Choose your preferred [release](https://github.com/vmware-tanzu/pinniped/releases) version number
|
||||||
and use it to replace the version number in the URL below.
|
and use it to replace the version number in the URL below.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Replace v0.2.0 with your preferred version in the URL below
|
# Replace v0.4.1 with your preferred version in the URL below
|
||||||
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/v0.2.0/install-pinniped-concierge.yaml
|
kubectl apply -f https://get.pinniped.dev/v0.4.1/install-pinniped-concierge.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installing with Custom Options
|
## Installing with Custom Options
|
||||||
|
@ -15,17 +15,17 @@ User accounts can be created and edited dynamically using `kubectl` commands (se
|
|||||||
## Installing the Latest Version with Default Options
|
## Installing the Latest Version with Default Options
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/latest/download/install-local-user-authenticator.yaml
|
kubectl apply -f https://get.pinniped.dev/latest/install-local-user-authenticator.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installing an Older Version with Default Options
|
## Installing a Specific Version with Default Options
|
||||||
|
|
||||||
Choose your preferred [release](https://github.com/vmware-tanzu/pinniped/releases) version number
|
Choose your preferred [release](https://github.com/vmware-tanzu/pinniped/releases) version number
|
||||||
and use it to replace the version number in the URL below.
|
and use it to replace the version number in the URL below.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Replace v0.2.0 with your preferred version in the URL below
|
# Replace v0.4.1 with your preferred version in the URL below
|
||||||
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/v0.2.0/install-local-user-authenticator.yaml
|
kubectl apply -f https://get.pinniped.dev/v0.4.1/install-local-user-authenticator.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installing with Custom Options
|
## Installing with Custom Options
|
||||||
|
@ -8,17 +8,17 @@ It can be deployed when those features are needed.
|
|||||||
## Installing the Latest Version with Default Options
|
## Installing the Latest Version with Default Options
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/latest/download/install-pinniped-supervisor.yaml
|
kubectl apply -f https://get.pinniped.dev/latest/install-pinniped-supervisor.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installing an Older Version with Default Options
|
## Installing a Specific Version with Default Options
|
||||||
|
|
||||||
Choose your preferred [release](https://github.com/vmware-tanzu/pinniped/releases) version number
|
Choose your preferred [release](https://github.com/vmware-tanzu/pinniped/releases) version number
|
||||||
and use it to replace the version number in the URL below.
|
and use it to replace the version number in the URL below.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Replace v0.3.0 with your preferred version in the URL below
|
# Replace v0.4.1 with your preferred version in the URL below
|
||||||
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/v0.3.0/install-pinniped-supervisor.yaml
|
kubectl apply -f https://get.pinniped.dev/v0.4.1/install-pinniped-supervisor.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installing with Custom Options
|
## Installing with Custom Options
|
||||||
|
@ -138,33 +138,20 @@ to authenticate federated identities from the Supervisor.
|
|||||||
EOF
|
EOF
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Query GitHub's API for the git tag of the latest Pinniped
|
|
||||||
[release](https://github.com/vmware-tanzu/pinniped/releases/latest).
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pinniped_version=$(curl https://api.github.com/repos/vmware-tanzu/pinniped/releases/latest -s | jq .name -r)
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, you can manually select [any release version](https://github.com/vmware-tanzu/pinniped/releases)
|
|
||||||
of Pinniped.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Example of manually choosing a release version...
|
|
||||||
pinniped_version=v0.3.0
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Deploy the Pinniped Concierge.
|
1. Deploy the Pinniped Concierge.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply \
|
kubectl apply \
|
||||||
--context kind-pinniped-concierge \
|
--context kind-pinniped-concierge \
|
||||||
-f https://github.com/vmware-tanzu/pinniped/releases/download/$pinniped_version/install-pinniped-concierge.yaml
|
-f https://get.pinniped.dev/latest/install-pinniped-concierge.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
The `install-pinniped-concierge.yaml` file includes the default deployment options.
|
The `install-pinniped-concierge.yaml` file includes the default deployment options.
|
||||||
If you would prefer to customize the available options, please see [deploy/concierge/README.md](https://github.com/vmware-tanzu/pinniped/blob/main/deploy/concierge/README.md)
|
If you would prefer to customize the available options, please see [deploy/concierge/README.md](https://github.com/vmware-tanzu/pinniped/blob/main/deploy/concierge/README.md)
|
||||||
for instructions on how to deploy using `ytt`.
|
for instructions on how to deploy using `ytt`.
|
||||||
|
|
||||||
|
If you prefer to install a specific version, replace `latest` in the above URL with the version number such as `v0.4.1`.
|
||||||
|
|
||||||
1. Generate a random audience value for this cluster.
|
1. Generate a random audience value for this cluster.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
@ -55,32 +55,14 @@ as the authenticator.
|
|||||||
installed on some Linux systems via the `apache2-utils` package (e.g., `apt-get install
|
installed on some Linux systems via the `apache2-utils` package (e.g., `apt-get install
|
||||||
apache2-utils`).
|
apache2-utils`).
|
||||||
|
|
||||||
- One of the steps below optionally uses `jq` to help find the latest release version number. It is not required.
|
|
||||||
Install `jq` if you would like, e.g. `brew install jq` on MacOS.
|
|
||||||
|
|
||||||
1. Create a new Kubernetes cluster using `kind create cluster`. Optionally provide a cluster name using the `--name` flag.
|
1. Create a new Kubernetes cluster using `kind create cluster`. Optionally provide a cluster name using the `--name` flag.
|
||||||
kind will automatically update your kubeconfig to point to the new cluster as a user with admin-like permissions.
|
kind will automatically update your kubeconfig to point to the new cluster as a user with admin-like permissions.
|
||||||
|
|
||||||
1. Query GitHub's API for the git tag of the latest Pinniped
|
|
||||||
[release](https://github.com/vmware-tanzu/pinniped/releases/latest).
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pinniped_version=$(curl https://api.github.com/repos/vmware-tanzu/pinniped/releases/latest -s | jq .name -r)
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, you can manually select [any release version](https://github.com/vmware-tanzu/pinniped/releases)
|
|
||||||
of Pinniped.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Example of manually choosing a release version...
|
|
||||||
pinniped_version=v0.3.0
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Deploy the local-user-authenticator app. This is a demo authenticator. In production, you would configure
|
1. Deploy the local-user-authenticator app. This is a demo authenticator. In production, you would configure
|
||||||
an authenticator that works with your real identity provider, and therefore would not need to deploy or configure local-user-authenticator.
|
an authenticator that works with your real identity provider, and therefore would not need to deploy or configure local-user-authenticator.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/$pinniped_version/install-local-user-authenticator.yaml
|
kubectl apply -f https://get.pinniped.dev/latest/install-local-user-authenticator.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
The `install-local-user-authenticator.yaml` file includes the default deployment options.
|
The `install-local-user-authenticator.yaml` file includes the default deployment options.
|
||||||
@ -88,6 +70,8 @@ as the authenticator.
|
|||||||
see [deploy/local-user-authenticator/README.md](https://github.com/vmware-tanzu/pinniped/blob/main/deploy/local-user-authenticator/README.md)
|
see [deploy/local-user-authenticator/README.md](https://github.com/vmware-tanzu/pinniped/blob/main/deploy/local-user-authenticator/README.md)
|
||||||
for instructions on how to deploy using `ytt`.
|
for instructions on how to deploy using `ytt`.
|
||||||
|
|
||||||
|
If you prefer to install a specific version, replace `latest` in the above URL with the version number such as `v0.4.1`.
|
||||||
|
|
||||||
1. Create a test user named `pinny-the-seal` in the local-user-authenticator namespace.
|
1. Create a test user named `pinny-the-seal` in the local-user-authenticator namespace.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@ -108,7 +92,7 @@ as the authenticator.
|
|||||||
1. Deploy the Pinniped Concierge.
|
1. Deploy the Pinniped Concierge.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply -f https://github.com/vmware-tanzu/pinniped/releases/download/$pinniped_version/install-pinniped-concierge.yaml
|
kubectl apply -f https://get.pinniped.dev/latest/install-pinniped-concierge.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
The `install-pinniped-concierge.yaml` file includes the default deployment options.
|
The `install-pinniped-concierge.yaml` file includes the default deployment options.
|
||||||
|
Loading…
Reference in New Issue
Block a user