diff --git a/doc/demo.md b/doc/demo.md index 88b728391..a555d38c7 100644 --- a/doc/demo.md +++ b/doc/demo.md @@ -9,17 +9,15 @@ 1. An identity provider of a type supported by Pinniped as described in [doc/architecture.md](../doc/architecture.md). - Don't have an identity provider of a type supported by Pinniped handy? - Start by installing `local-user-authenticator` on the same cluster where you would like to try Pinniped + Don't have an identity provider of a type supported by Pinniped handy? No problem, there is a demo identity provider + available. Start by installing local-user-authenticator on the same cluster where you would like to try Pinniped by following the directions in [deploy-local-user-authenticator/README.md](../deploy-local-user-authenticator/README.md). See below for an example of deploying this on kind. 1. A kubeconfig where the current context points to the cluster and has admin-like privileges on that cluster. -## Steps - -### Overview +## Overview Installing and trying Pinniped on any cluster will consist of the following general steps. See the next section below for a more specific example of installing onto a local kind cluster, including the exact commands to use for that case. @@ -29,7 +27,23 @@ for a more specific example of installing onto a local kind cluster, including t 1. Generate a kubeconfig using the Pinniped CLI. Run `pinniped get-kubeconfig --help` for more information. 1. Run `kubectl` commands using the generated kubeconfig. Pinniped will automatically be used for authentication during those commands. -### Steps to Deploy the Latest Release on kind Using local-user-authenticator as the Identity Provider +## Example of Deploying on kind + +[kind](https://kind.sigs.k8s.io) is a tool for creating and managing Kubernetes clusters on your local machine +which uses Docker containers as the cluster's "nodes". This is a convenient way to try out Pinniped on a local +non-production cluster. + +The following steps will deploy the latest release of Pinniped on kind using the local-user-authenticator component +as the identity provider. + + +
+
+