Skip to content

Commit 338a1b5

Browse files
author
Tim Middleton
authored
Update Example README to include v2 and V3 helm commands (#427)
1 parent 34e10bc commit 338a1b5

File tree

5 files changed

+56
-18
lines changed

5 files changed

+56
-18
lines changed

examples/deployment/README.md

Lines changed: 46 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can use `kubectl create` for any of the examples to install that one directl
2121

2222
* [Prerequisites](#prerequisites)
2323
* [Coherence Operator Quick Start](#coherence-operator-quick-start)
24-
* [JDK and Maven Versions](#jdk-and-maven-versions)
24+
* [Software Versions](#software-versions)
2525
* [Create the example namespace](#create-the-example-namespace)
2626
* [Clone the GitHub repository](#clone-the-github-repository)
2727
* [Install the Coherence Operator](#install-the-coherence-operator)
@@ -41,7 +41,7 @@ You can use `kubectl create` for any of the examples to install that one directl
4141
Ensure you have followed all the [Quick Start Guide](https://oracle.github.io/coherence-operator/docs/#/about/03_quickstart) including the
4242
prerequisites and have been able to successfully install the Coherence Operator and a Coherence Cluster.
4343

44-
## JDK and Maven versions
44+
## Software Versions
4545

4646
Ensure you have the following software installed:
4747

@@ -50,6 +50,7 @@ Ensure you have the following software installed:
5050
* [Docker](https://docs.docker.com/install/) version 17.03+.
5151
* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) version v1.12.0+ .
5252
* Access to a Kubernetes v1.12.0+ cluster.
53+
* [Helm](https://helm.sh/docs/intro/install/) version 3.2.4+ (2.14.3+ supported, see notes)
5354

5455
> Note: Ensure that your local Kubernetes is enabled. If you are running Docker using Docker Desktop, select Enable Kubernetes in the Settings menu.
5556
@@ -95,7 +96,7 @@ This will result in the following Docker image being created which contains the
9596
artifacts to be use by all deployments.
9697

9798
```console
98-
deployment-example:3.0.0
99+
deployment-example:3.0.1
99100
```
100101

101102
> Note: If you are running against a remote Kubernetes cluster, you need to tag and
@@ -106,8 +107,14 @@ deployment-example:3.0.0
106107

107108
Issue the following command to install the Coherence Operator:
108109

110+
```bash
111+
helm install --namespace coherence-example coherence-operator coherence/coherence-operator
112+
```
113+
114+
> Note: for Helm version 2, use the following:
115+
109116
```bash
110-
helm install coherence/coherence-operator --version 3.0.0 --namespace coherence-example --name coherence-operator
117+
helm install coherence/coherence-operator --namespace coherence-example --name coherence-operator
111118
```
112119

113120
Confirm the operator is running:
@@ -262,7 +269,7 @@ spec:
262269
storageEnabled: false
263270
metrics:
264271
enabled: true
265-
image: tmiddlet/deployment-example:3.0.0
272+
image: deployment-example:3.0.1
266273
imagePullPolicy: Always
267274
replicas: 1
268275
```
@@ -374,7 +381,7 @@ spec:
374381
storageEnabled: false
375382
metrics:
376383
enabled: true
377-
image: tmiddlet/deployment-example:3.0.0
384+
image: deployment-example:3.0.1
378385
imagePullPolicy: Always
379386
application:
380387
main: com.oracle.coherence.examples.Main
@@ -643,6 +650,14 @@ install any of the examples above.
643650
644651
## Install Prometheus Operator
645652
653+
1. Add the `stable` helm repository
654+
655+
```bash
656+
helm repo add stable https://kubernetes-charts.storage.googleapis.com/
657+
658+
helm repo update
659+
```
660+
646661
1. Create Prometheus pre-requisites
647662
648663
```bash
@@ -666,6 +681,17 @@ install any of the examples above.
666681
> Note: If you have already installed Prometheus Operator before on this Kubernetes Cluster
667682
> then set `--set prometheusOperator.createCustomResource=false`.
668683
684+
Issue the following command to install the Prometheus Operator using Helm:
685+
686+
```bash
687+
helm install --namespace coherence-example --version 8.13.9 \
688+
--set grafana.enabled=true \
689+
--set prometheusOperator.createCustomResource=true \
690+
--values src/main/yaml/prometheus-values.yaml prometheus stable/prometheus-operator
691+
```
692+
693+
> Note: for Helm version 2, use the following:
694+
669695
```bash
670696
helm install --namespace coherence-example --version 8.13.9 \
671697
--set grafana.enabled=true --name prometheus \
@@ -736,21 +762,33 @@ in the `examples/bin/` directory.
736762
737763
1. Remove the Coherence Operator
738764
765+
```bash
766+
helm delete coherence-operator --namespace coherence-example
767+
```
768+
769+
> For Helm version 2 use the following:
770+
739771
```bash
740772
helm delete coherence-operator --purge
741773
```
742774
743775
1. Delete Prometheus Operator
744776
745777
```bash
746-
helm delete prometheus --purge
778+
helm delete prometheus --namespace coherence-example
747779
748780
kubectl -n coherence-example delete -f src/main/yaml/grafana-datasource-config.yaml
749781
750782
kubectl -n coherence-example delete configmap coherence-grafana-dashboards
751783
752784
kubectl delete -f src/main/yaml/prometheus-rbac.yaml
753-
```
785+
```
786+
787+
> For Helm version 2 use the following:
788+
789+
```bash
790+
helm delete prometheus --purge
791+
```
754792
755793
> Note: You can optionally delete the Prometheus Operator Custom Resource Definitions
756794
> (CRD's) if you are not going to install Prometheus Operator again.

examples/deployment/src/main/yaml/example-cluster-app.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ spec:
2525
cacheConfig: storage-cache-config.xml
2626
metrics:
2727
enabled: true
28-
image: deployment-example:3.0.0
28+
image: deployment-example:3.0.1
2929
imagePullPolicy: Always
3030
replicas: 3
3131
---
@@ -52,7 +52,7 @@ spec:
5252
storageEnabled: false
5353
metrics:
5454
enabled: true
55-
image: deployment-example:3.0.0
55+
image: deployment-example:3.0.1
5656
imagePullPolicy: Always
5757
replicas: 1
5858
---
@@ -79,8 +79,8 @@ spec:
7979
storageEnabled: false
8080
metrics:
8181
enabled: true
82-
image: deployment-example:3.0.0
82+
image: deployment-example:3.0.1
8383
imagePullPolicy: Always
8484
application:
8585
main: com.oracle.coherence.examples.Main
86-
replicas: 1
86+
replicas: 1

examples/deployment/src/main/yaml/example-cluster-persistence.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ spec:
3333
resources:
3434
requests:
3535
storage: 1Gi
36-
image: deployment-example:3.0.0
36+
image: deployment-example:3.0.1
3737
imagePullPolicy: Always
3838
replicas: 3
3939
---
@@ -60,7 +60,7 @@ spec:
6060
storageEnabled: false
6161
metrics:
6262
enabled: true
63-
image: deployment-example:3.0.0
63+
image: deployment-example:3.0.1
6464
imagePullPolicy: Always
6565
replicas: 1
6666
---
@@ -87,7 +87,7 @@ spec:
8787
storageEnabled: false
8888
metrics:
8989
enabled: true
90-
image: deployment-example:3.0.0
90+
image: deployment-example:3.0.1
9191
imagePullPolicy: Always
9292
application:
9393
main: com.oracle.coherence.examples.Main

examples/deployment/src/main/yaml/example-cluster-proxy.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ spec:
2525
cacheConfig: storage-cache-config.xml
2626
metrics:
2727
enabled: true
28-
image: deployment-example:3.0.0
28+
image: deployment-example:3.0.1
2929
imagePullPolicy: Always
3030
replicas: 3
3131
---
@@ -52,6 +52,6 @@ spec:
5252
storageEnabled: false
5353
metrics:
5454
enabled: true
55-
image: deployment-example:3.0.0
55+
image: deployment-example:3.0.1
5656
imagePullPolicy: Always
5757
replicas: 1

examples/deployment/src/main/yaml/example-cluster.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ spec:
2525
cacheConfig: storage-cache-config.xml
2626
metrics:
2727
enabled: true
28-
image: deployment-example:3.0.0
28+
image: deployment-example:3.0.1
2929
imagePullPolicy: Always
3030
replicas: 3

0 commit comments

Comments
 (0)