Skip to content

Commit a5d2348

Browse files
Add a reamde in the helm chart
It is going to be displayed in artifacthub.io Co-authored-by: Danail Branekov <[email protected]>
1 parent a12df90 commit a5d2348

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

helm/korifi/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Korifi Helm Chart
2+
Korifi is a kubernetes native implementation of the Cloud Foundry V3 API. For more information check out the [project on github](https://github.com/cloudfoundry/korifi)
3+
4+
# Quick Start
5+
6+
If you want to try out Korifi on your local machine we recommend [installing korifi on kind](https://github.com/cloudfoundry/korifi/blob/main/INSTALL.kind.md)
7+
8+
# Installation
9+
10+
1. Make sure [dependencies](https://github.com/cloudfoundry/korifi/blob/main/INSTALL.md#dependencies) are installed
11+
12+
13+
2. Add the korifi repository:
14+
15+
```
16+
helm repo add korifi https://cloudfoundry.github.io/korifi/
17+
```
18+
19+
3. Install the korifi helm chart
20+
21+
```
22+
helm install my-korifi korifi/korifi
23+
--create-namespace \
24+
--namespace=korifi \
25+
--set=generateIngressCertificates=true \
26+
--set=adminUserName=cf-admin \
27+
--set=api.apiServer.url="api.korifi.example.org" \
28+
--set=defaultAppDomainName="apps.korifi.example.org" \
29+
--set=containerRepositoryPrefix=index.docker.io/my-organization/ \
30+
--set=kpackImageBuilder.builderRepository=index.docker.io/my-organization/kpack-builder \
31+
--set=networking.gatewayClass=contour \
32+
--wait
33+
```
34+
35+
Refer to the [installation guide](https://github.com/cloudfoundry/korifi/blob/main/INSTALL.md) for more information on how to configure the helm values

0 commit comments

Comments
 (0)