Restructure docs into new layout.

Signed-off-by: Matt Moyer <moyerm@vmware.com>
2026-09-19 14:34:27 +00:00 · 2021-02-23 11:11:07 -06:00
parent f2db76a0d5
commit 7a1d92a8d4
34 changed files with 973 additions and 439 deletions
@@ -0,0 +1,13 @@
+---
+cascade:
+  layout: docs
+menu:
+  docs:
+    name: Reference
+    identifier: reference
+    weight: 100
+---
+
+# Pinniped reference
+
+{{< docsmenu "reference" >}}
@@ -0,0 +1,12 @@
+---
+title: API
+description: Reference for the `*.pinniped.dev` Kubernetes API groups.
+cascade:
+  layout: docs
+menu:
+  docs:
+    name: Kubernetes API
+    weight: 35
+    parent: reference
+---
+Full API reference documentation for the Pinniped Kubernetes API is available [on GitHub](https://github.com/vmware-tanzu/pinniped/blob/main/generated/1.20/README.adoc).
@@ -0,0 +1,84 @@
+---
+title: Command-Line Options Reference
+description: Reference for the `pinniped` command-line tool
+cascade:
+  layout: docs
+menu:
+  docs:
+    name: Command-Line Options
+    weight: 30
+    parent: reference
+---
+
+## `pinniped version`
+
+Print the version of this Pinniped CLI.
+
+```sh
+pinniped version [flags]
+```
+
+- `-h`, `--help`:
+
+   help for kubeconfig
+
+## `pinniped get kubeconfig`
+
+Generate a Pinniped-based kubeconfig for a cluster.
+
+```sh
+pinniped get kubeconfig [flags]
+```
+
+- `-h`, `--help`:
+
+   help for kubeconfig
+
+- `--concierge-api-group-suffix string`:
+
+  Concierge API group suffix (default "pinniped.dev")
+- `--concierge-authenticator-name string`:
+
+  Concierge authenticator name (default: autodiscover)
+- `--concierge-authenticator-type string`:
+
+  Concierge authenticator type (e.g., 'webhook', 'jwt') (default: autodiscover)
+- `--kubeconfig string`:
+
+  Path to kubeconfig file
+- `--kubeconfig-context string`:
+
+  Kubeconfig context name (default: current active context)
+- `--no-concierge`:
+
+  Generate a configuration which does not use the concierge, but sends the credential to the cluster directly
+- `--oidc-ca-bundle strings`:
+
+  Path to TLS certificate authority bundle (PEM format, optional, can be repeated)
+- `--oidc-client-id string`:
+
+  OpenID Connect client ID (default: autodiscover) (default "pinniped-cli")
+- `--oidc-issuer string`:
+
+  OpenID Connect issuer URL (default: autodiscover)
+- `--oidc-listen-port uint16`:
+
+  TCP port for localhost listener (authorization code flow only)
+- `--oidc-request-audience string`:
+
+  Request a token with an alternate audience using RFC8693 token exchange
+- `--oidc-scopes strings`:
+
+  OpenID Connect scopes to request during login (default [offline_access,openid,pinniped:request-audience])
+- `--oidc-session-cache string`:
+
+  Path to OpenID Connect session cache file
+- `--oidc-skip-browser`:
+
+  During OpenID Connect login, skip opening the browser (just print the URL)
+- `--static-token string`:
+
+  Instead of doing an OIDC-based login, specify a static token
+- `--static-token-env string`:
+
+  Instead of doing an OIDC-based login, read a static token from the environment
@@ -0,0 +1,29 @@
+---
+title: Supported cluster types
+description: See the supported cluster types for the Pinniped Concierge.
+cascade:
+  layout: docs
+menu:
+  docs:
+    name: Supported Cluster Types
+    weight: 10
+    parent: reference
+---
+
+| **Cluster Type** | **Conciege Works?** |
+|-|-|
+| [VMware Tanzu Kubernetes Grid (TKG) clusters](https://tanzu.vmware.com/kubernetes-grid) | Yes |
+| [Kind clusters](https://kind.sigs.k8s.io/) | Yes |
+| [Kubeadm-based clusters](https://kubernetes.io/docs/reference/setup-tools/kubeadm/) | Yes |
+| [Amazon Elastic Kubernetes Service (EKS)](https://aws.amazon.com/eks/) | No |
+| [Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine) | No |
+| [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-us/overview/kubernetes-on-azure) | No |
+
+## Background
+
+The Pinniped Concierge currently supports clusters where a custom pod can be executed on the  same node running `kube-controller-manager`.
+This type of cluster is typically called "self-hosted" because the cluster's control plane is running on nodes that are part of the cluster itself.
+
+In practice, this means that many Kubernetes distributions are supported, but not most managed Kubernetes services
+
+Support for more cluster types, including managed Kubernetes environments, is planned.