Pinniped packaged by Bitnami¶

Pinniped is an identity service provider for Kubernetes. It supplies a consistent and unified login experience across all your clusters. Pinniped is securely integrated with enterprise IDP protocols.

Overview of Pinniped

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR¶

使用加速地址添加仓库:

helm repo add bitnami "https://helm-charts.itboon.top/bitnami" --force-update
helm update bitnami

helm install my-release bitnami/pinniped

Introduction¶

Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.

This chart bootstraps a Pinniped Deployment in a Kubernetes cluster using the Helm package manager.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This Helm chart has been tested on top of Bitnami Kubernetes Production Runtime (BKPR). Deploy BKPR to get automated TLS certificates, logging and monitoring for your applications.

Learn more about the default configuration of the chart.

Looking to use Pinniped in production? Try VMware Application Catalog, the enterprise edition of Bitnami Application Catalog.

Prerequisites¶

• Kubernetes 1.19+
• Helm 3.2.0+

Installing the Chart¶

To install the chart with the release name my-release:

helm install my-release bitnami/pinniped

The command deploys pinniped on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Uninstalling the Chart¶

To uninstall/delete the my-release deployment:

helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters¶

Global parameters¶

Common parameters¶

Concierge Parameters¶

Concierge RBAC settings¶

Concierge Traffic Exposure Parameters¶

Supervisor Parameters¶

Supervisor RBAC settings¶

Supervisor Traffic Exposure Parameters¶

See https://github.com/bitnami-labs/readme-generator-for-helm to create the table

The above parameters map to the env variables defined in bitnami/pinniped. For more information please refer to the bitnami/pinniped image documentation.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

helm install my-release \
  --set supervisor.enabled=false \
    bitnami/pinniped

The above command sets disables the supervisor compoment deployment.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

helm install my-release -f values.yaml bitnami/pinniped

Tip: You can use the default values.yaml

Configuration and installation details¶

Rolling VS Immutable tags¶

It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.

Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.

Persistence¶

The Bitnami pinniped image stores the pinniped data and configurations at the /bitnami path of the container. Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube.

Additional environment variables¶

In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars property.

pinniped:
  extraEnvVars:
    - name: LOG_LEVEL
      value: error

Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM or the extraEnvVarsSecret values.

Sidecars¶

If additional containers are needed in the same pod as pinniped (such as additional metrics or logging exporters), they can be defined using the sidecars parameter. If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts parameter. Learn more about configuring and using sidecar containers.

Pod affinity¶

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod affinity in the kubernetes documentation.

As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

Troubleshooting¶

Find more information about how to deal with common errors related to Bitnami's Helm charts in this troubleshooting guide.

Upgrading¶

To 1.0.0¶

This version brings a breaking change into the configuration, eliminating abused reuse of Pinniped service parameters. The supervisor.service object is now separated into supervisor.service.api which configures the service used by Pinniped internally, and supervisor.service.public which configures the service the users interact with. In case configuration was specified in the supervisor.service object, now it needs to be redistributed into the two new objects. Keep in mind that the API service default service type was also changed to ClusterIP to reflect more on how the API service is used by default. Also the formerly supervisor.service.ports.aggregatedAPIService parameter is now only available under the API service configuration, because it is not a relevant parameter for the user-facing service.

To 0.4.0¶

This version updates Pinniped to its newest version, 0.20.x. For more information, please refer to the release notes.

License¶

Copyright © 2023 VMware, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.