Skip to content
This repository was archived by the owner on Nov 18, 2020. It is now read-only.

Commit 2c9a675

Browse files
review changes
1 parent 30b4c60 commit 2c9a675

File tree

3 files changed

+25
-13
lines changed

3 files changed

+25
-13
lines changed

helm/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
This project is a component of the [Operator Framework](https://github.com/operator-framework), an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way. Read more in the [introduction blog post](https://coreos.com/blog/introducing-operator-framework).
2+
3+
# Operator SDK Samples - Helm
4+
This directory contains samples of operators powered by Helm built using the [operator-sdk][operator_sdk]. To learn more about creating an operator that leverages Helm, check out the [Helm user guide][helm_user_guide].
5+
6+
[operator_sdk]:https://github.com/coreos/operator-sdk
7+
[helm_user_guide]:https://github.com/operator-framework/operator-sdk/blob/master/doc/helm/user-guide.md

helm/memcached-operator/README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
## Overview
44

5-
This Memcached operator is a simple example operator based in Helm built with the [Operator SDK][operator_sdk].
5+
This Memcached operator is a simple example of the Operator SDK Helm-based operator. It is based on the [`stable/memcached` chart][stable/memcached] .
66

77
## Prerequisites
88

99
- [docker][docker_tool] version 17.03+
10-
- [kubectl][kubectl_tool] v1.11.3+
11-
- [operator_sdk][operator_install]
12-
- Access to a Kubernetes v1.11.3+ cluster
10+
- [kubectl][kubectl_tool] v1.12+
11+
- [operator SDK][operator_install]
12+
- Access to a Kubernetes v1.14.5+ cluster
1313

1414
## Getting Started
1515

1616
### Cloning the repository
1717

18-
Checkout this Memcached Operator repository
18+
Checkout this Memcached operator repository
1919

2020
```
2121
$ mkdir operator-framework
@@ -38,18 +38,23 @@ $ docker push $IMAGE
3838

3939
### Using the image
4040

41+
Update the operator manifest to use the built image name (if you are performing these steps on OSX, see note below)
42+
4143
```
42-
# Update the operator manifest to use the built image name (if you are performing these steps on OSX, see note below)
4344
$ sed -i 's|REPLACE_IMAGE|quay.io/example-inc/memcached-operator|g' deploy/operator.yaml
44-
# On OSX use:
45+
```
46+
47+
**Note**
48+
If you are performing these steps on OSX, use the following `sed` command instead:
49+
```
4550
$ sed -i "" 's|REPLACE_IMAGE|quay.io/example-inc/memcached-operator|g' deploy/operator.yaml
4651
```
4752

4853
### Installing
4954

5055
Run `make install` to install the operator. Check that the operator is running in the cluster, also check that the example Memcached service was deployed.
5156

52-
Following the expected result.
57+
Run the following command to verify that the installation was successful:
5358

5459
```shell
5560
$ kubectl get all -n helm-memcached -o wide
@@ -75,7 +80,7 @@ statefulset.apps/example-memcached 3/3 37s example-memcached memcached
7580

7681
### Uninstalling
7782

78-
To uninstall all that was performed in the above step run `make uninstall`.
83+
Run `make uninstall` to uninstall all that was performed in the above step.
7984

8085
### Troubleshooting
8186

@@ -85,19 +90,18 @@ Run the following command to check the operator logs.
8590
kubectl logs deployment.apps/memcached-operator -n helm-memcached
8691
```
8792

88-
**NOTE** To have further information about how to develop Helm operators with [Operator-SDK][operator_sdk] check the [Helm User Guide for Operator-SDK][helm_guide]
93+
**NOTE** For further information about how to develop Helm operators with Operator SDK, read the [Helm User Guide for Operator SDK][helm_guide]
8994

9095
### Extras
9196

92-
Mote that this project was created by using the following command which means that it is using the [stable/memcached][stable/memcached]
97+
This project was created by using the following command, which means that it is using the official [stable/memcached][stable/memcached] helm chart.
9398

9499
```shell
95100
operator-sdk new memcached-operator --api-version=cache.example.com/v1alpha1 --kind=Memcached --type=helm --helm-chart=stable/memcached
96101
```
97102

98103
[kubectl_tool]: https://kubernetes.io/docs/tasks/tools/install-kubectl/
99104
[docker_tool]: https://docs.docker.com/install/
100-
[operator_sdk]: https://github.com/operator-framework/operator-sdk
101105
[operator_install]: https://github.com/operator-framework/operator-sdk/blob/master/doc/user/install-operator-sdk.md
102106
[helm_guide]: https://github.com/operator-framework/operator-sdk/blob/master/doc/helm/user-guide.md
103-
[stable/memcached]: https://github.com/helm/charts/tree/master/stable/memcached
107+
[stable/memcached]: https://github.com/helm/charts/tree/master/stable/memcached

helm/memcached-operator/deploy/role.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ rules:
6161
- apps
6262
resources:
6363
- replicasets
64+
- deployments
6465
verbs:
6566
- get
6667
- apiGroups:

0 commit comments

Comments
 (0)