Skip to content

Commit

Permalink
Improve installation docs (#3)
Browse files Browse the repository at this point in the history
- Add make command to build full YAML from Kustomize
- Change docs to link to this YAML
  • Loading branch information
brantburnett authored Oct 18, 2021
1 parent 8f7adf5 commit 2d28585
Show file tree
Hide file tree
Showing 5 changed files with 534 additions and 7 deletions.
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# To re-generate a bundle for another specific version without changing the standard setup, you can:
# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
# - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
VERSION ?= 0.0.1
VERSION ?= 1.0.0

# CHANNELS define the bundle channels used in the bundle.
# Add a new line here if you would like to change its default config. (E.g CHANNELS = "candidate,fast,stable")
Expand Down Expand Up @@ -120,6 +120,9 @@ deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in
undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config.
$(KUSTOMIZE) build config/default | kubectl delete -f -

install-docs: manifests kustomize ## Build install doc yaml
cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
$(KUSTOMIZE) build config/default > docs/install/v$(VERSION).yaml

CONTROLLER_GEN = $(shell pwd)/bin/controller-gen
controller-gen: ## Download controller-gen locally if necessary.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ may target any accessible Couchbase cluster.

## Installing

An example installation is available in the `config/default` directory.
Example installations are available in the `docs/install` directory.

```sh
kubectl apply -k https://github.com/brantburnett/couchbase-index-operator/config/default
kubectl apply -f https://github.com/brantburnett/couchbase-index-operator/docs/install/v1.0.0.yaml
```

This will deploy the operator in the default namespace, and it will only operate on resources
Expand Down
7 changes: 7 additions & 0 deletions config/default/manager_auth_proxy_patch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ spec:
ports:
- containerPort: 8443
name: https
resources:
limits:
cpu: 100m
memory: 128Mi
requests:
cpu: 100m
memory: 128Mi
- name: manager
args:
- "--health-probe-bind-address=:8081"
Expand Down
10 changes: 6 additions & 4 deletions config/manager/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

resources:
- manager.yaml

Expand All @@ -8,9 +11,8 @@ configMapGenerator:
- files:
- controller_manager_config.yaml
name: manager-config
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

images:
- name: controller
newName: controller
newTag: latest
newName: ghcr.io/brantburnett/couchbase-index-operator
newTag: 1.0.0-beta001
Loading

0 comments on commit 2d28585

Please sign in to comment.