From dd0ccca77065b61085980bdfa24d3709545f66cc Mon Sep 17 00:00:00 2001 From: Robert Stefan Date: Wed, 22 Jul 2020 12:42:09 +0300 Subject: [PATCH] Update readme with how to install CRDs --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 13d30ece..27c97aae 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ wordpress-operator === WordPress operator enables managing multiple WordPress installments at scale. + + ## Goals and status The main goals of the operator are: @@ -13,23 +15,45 @@ The main goals of the operator are: The project is actively developed and maintained and has reached stable beta state. Check [here](https://github.com/presslabs/wordpress-operator/releases) the project releases. + + ## Components 1. WordPress operator - this project 2. WordPress runtime - container image supporting the project goals (https://github.com/presslabs/runtime) -## Controller deploy + + +## Deploy + +### Install CRDs + +#### This step is optional. By default helm will install CRDs. + +Install kustomize. New to kustomize? Check https://kustomize.io/ + +To install CRDs use the following command: + +```shell +kustomize build github.com/presslabs/wordpress-operator/config | kubectl apply -f- +``` + + +### Install controller Install helm. New to helm? Check https://github.com/helm/helm#install Install kubectl. For more details, see: https://kubernetes.io/docs/tasks/tools/install-kubectl/ To deploy this controller, use the provided helm chart, by running: + ```shell helm repo add presslabs https://presslabs.github.io/charts helm install presslabs/wordpress-operator --name wordpress-operator ``` + + ## Deploying a Wordpress Site ```yaml @@ -126,6 +150,8 @@ spec: ingressAnnotations: {} ``` + + ## License This project is licensed under Apache 2.0 license. Read the [LICENSE](LICENSE) file in the