Merge pull request #60 from epinio/olblak-patch-1

Add helm repo update command to README
epinio · Jan 14, 2022 · 2fd788e · 2fd788e
2 parents e3fc822 + bed98f2
commit 2fd788e
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 11 deletions.
diff --git a/chart/epinio-installer/README.md b/chart/epinio-installer/README.md
@@ -1,17 +1,18 @@
-# Epinio Helm Chart
+# Epinio Installer Helm Chart
 
-From app to URL in one command.
+From app to URL in one command. This chart installs Epinio and all dependencies.
 
 ## Introduction
 
-This helm chart can be used to deploy Epinio on a cluster. It is an alternative
-to `epinio install` command.
+This helm chart can be used to deploy Epinio on a cluster. It includes the [Epinio server helm chart]((https://artifacthub.io/packages/helm/epinio/epinio).
+It is best used with a fresh cluster.
 
 ## Usage
 
-The doc is centralized in a uniq place, checkout the [doc website](https://docs.epinio.io/installation/install_epinio_with_helm.html).
+The documentation is centralized in the [doc website](https://docs.epinio.io/installation/install_epinio_with_helm.html).
 
-## Development
+## Example
 
-    % helm upgrade --install -n epinio --create-namespace --set "skipLinkerd=true" epinio-installer chart/epinio-installer
+    % helm repo add epinio https://epinio.github.io/helm-charts/
+    % helm upgrade --install -n epinio --create-namespace --set "skipLinkerd=true" epinio-installer epinio/epinio-installer
     % helm uninstall -n epinio epinio-installer
diff --git a/chart/epinio-installer/templates/NOTES.txt b/chart/epinio-installer/templates/NOTES.txt
@@ -5,7 +5,7 @@ You can get the IP address of your Ingress controller by passing this command:
 
 Make sure your domain points to the IP address of your Ingress controller (1.2.3.4).
 {{ end }}
-To interract with your Epinio installation, you have to download the latest epinio binary https://github.com/epinio/epinio/releases.
+To interact with your Epinio installation, you have to download the latest epinio binary https://github.com/epinio/epinio/releases.
 
 Update the api location and credentials with:
 `epinio config update`

diff --git a/chart/epinio/README.md b/chart/epinio/README.md
@@ -10,9 +10,19 @@ are already deployed on the cluster.
 
 This chart can be used in a manual installation of Epinio components.
 
-There is also a helm chart that installs all of components automatically:
+The documentation is centralized in the [doc website](https://docs.epinio.io/installation/install_epinio_with_helm.html).
 
+## Relation to Epinio Installer Chart
 
+There is also a helm chart that installs all of components automatically: [epinio-installer](https://artifacthub.io/packages/helm/epinio/epinio-installer)
+
+To use this chart, after using the epinio-installer chart, first export all values:
+
+```
+helm repo add epinio https://epinio.github.io/helm-charts/
+helm get values -n epinio epinio > values.yaml
+helm upgrade --install -n epinio --create-namespace --values values.yaml epinio epinio/epinio
+```
 
 ## Prerequisites
 
@@ -34,7 +44,7 @@ Install linkerd with:
 
 ```
 $ kubectl create namespace linkerd
-$ kubectl apply -f assets/embedded-files/linkerd/rbac.yaml 
+$ kubectl apply -f assets/embedded-files/linkerd/rbac.yaml
 $ linkerd install | kubectl apply -f - && linkerd check --wait 10m
 ```
 
@@ -57,7 +67,7 @@ $ helm install traefik --namespace traefik "https://helm.traefik.io/traefik/trae
 ### Install Kubed
 
 ```
-$ kubectl create namespace kubed 
+$ kubectl create namespace kubed
 $ helm repo add appscode https://charts.appscode.com/stable/
 $ helm repo update
 $ helm install kubed --namespace kubed --version v0.12.0 appscode/kubed