Skip to content

Commit

Permalink
chore: update readme & pinniped chart readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Romain DARY - merlin committed Nov 19, 2021
1 parent ca28359 commit 95ea967
Show file tree
Hide file tree
Showing 3 changed files with 109 additions and 2 deletions.
69 changes: 68 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,71 @@
Charts
======

Helm chart created mainly for personal use or with a pending contribution.
![Helm-Doc: 1.5.0](https://img.shields.io/badge/Helm Doc-1.5.0-informational?style=flat-square)

> Helm chart created mainly for personal use or with a pending contribution.
## TL;DR

```shell
helm repo add merlindorin https://merlindorin.github.io/charts
helm search repo merlindorin

# Install any chart you need
helm install my-release merlindorin/<chart>
```

## Chart available

| Chart Name | Description | Last Version | Install |
|------------|-------------|--------------|---------|
| `pinniped` | Pinniped meta chart that regroup supervisor & concierge with ready to use template | `0.1.4` | `helm install my-release merlindorin/pinniped`
| `pinniped-supervisor` | Pinniped Supervisor only chart | `0.1.2` | `helm install my-release merlindorin/pinniped-supervisor`
| `pinniped-concierge` | Pinniped Concierge only chart | `0.1.2` | `helm install my-release merlindorin/pinniped-concierge`

## Before you begin

### Prerequisites

- Kubernetes 1.12+
- Helm 3.1.0

### Setup a Kubernetes Cluster

For setting up Kubernetes on other cloud platforms or bare-metal servers refer to the Kubernetes [getting started guide](http://kubernetes.io/docs/getting-started-guides/).

### Install Helm

Helm is a tool for managing Kubernetes charts. Charts are packages of pre-configured Kubernetes resources.

To install Helm, refer to the [Helm install guide](https://github.com/helm/helm#install) and ensure that the `helm` binary is in the `PATH` of your shell.

### Add Repo

The following command allows you to download and install all the charts from this repository:

```bash
$ helm repo add merlindorin https://merlindorin.github.io/charts
```

### Using Helm

Once you have installed the Helm client, you can deploy a Merlindorin Helm Chart into a Kubernetes cluster.

Please refer to the [Quick Start guide](https://helm.sh/docs/intro/quickstart/) if you wish to get running in just a
few commands, otherwise the [Using Helm Guide](https://helm.sh/docs/intro/using_helm/) provides detailed instructions
on how to use the Helm client to manage packages on your Kubernetes cluster.

Useful Helm Client Commands:
* View available charts: `helm search repo`
* Install a chart: `helm install my-release merlindorin/<package-name>`
* Upgrade your application: `helm upgrade`

## Development

- Generate Chart Documentation: `docker run --rm --volume "$(pwd):/helm-docs" -u $(id -u) jnorwood/helm-docs:latest`

## References

- Pinniped Project: [https://github.com/vmware-tanzu/pinniped](https://github.com/vmware-tanzu/pinniped)
- Bitnami Charts: [https://github.com/bitnami/charts](https://github.com/bitnami/charts)
2 changes: 1 addition & 1 deletion charts/pinniped/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: pinniped
description: A Meta Pinniped Helm chart for Kubernetes
type: application

version: 0.1.3
version: 0.1.4

dependencies:
- condition: supervisor.enabled
Expand Down
40 changes: 40 additions & 0 deletions charts/pinniped/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# pinniped

![Version: 0.1.2](https://img.shields.io/badge/Version-0.1.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)

A Meta Pinniped Helm chart for Kubernetes

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| https://merlindorin.github.io/charts | concierge(pinniped-concierge) | 0.1.1 |
| https://merlindorin.github.io/charts | supervisor(pinniped-supervisor) | 0.1.1 |

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| concierge.enabled | bool | `false` | |
| concierge.jwtAuthenticator.audience | string | `nil` | |
| concierge.jwtAuthenticator.enabled | bool | `false` | |
| concierge.jwtAuthenticator.issuer | string | `nil` | |
| concierge.jwtAuthenticator.tls.certificateAuthorityData | string | `nil` | |
| supervisor.enabled | bool | `false` | |
| supervisor.federation.enabled | bool | `false` | |
| supervisor.federation.issuer | string | `nil` | |
| supervisor.federation.tls.secretName | string | `nil` | |
| supervisor.identityProvider.ldap.bind.secretName | string | `nil` | |
| supervisor.identityProvider.ldap.enabled | bool | `false` | |
| supervisor.identityProvider.ldap.groupSearch.attributes.groupName | string | `nil` | |
| supervisor.identityProvider.ldap.groupSearch.base | string | `nil` | |
| supervisor.identityProvider.ldap.groupSearch.filter | string | `nil` | |
| supervisor.identityProvider.ldap.host | string | `nil` | |
| supervisor.identityProvider.ldap.tls.certificateAuthorityData | string | `nil` | |
| supervisor.identityProvider.ldap.userSearch.attributes.uid | string | `nil` | |
| supervisor.identityProvider.ldap.userSearch.attributes.username | string | `nil` | |
| supervisor.identityProvider.ldap.userSearch.base | string | `nil` | |
| supervisor.identityProvider.ldap.userSearch.filter | string | `nil` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)

0 comments on commit 95ea967

Please sign in to comment.