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

Commit 66156b1

Browse files
author
Eric Stroczynski
authored
*: fix links (#125)
1 parent 01a0e2d commit 66156b1

9 files changed

Lines changed: 28 additions & 29 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@ This project is a component of the [Operator Framework](https://github.com/opera
33
# Operator SDK Samples
44
This repo contains samples of operators built using the [operator-sdk][operator_sdk].
55

6-
To view operators which leverage Ansible or Helm for deployment, see the [Ansible][ansible_examples] or [Helm][helm_examples] samples sections.
6+
To view operators which leverage Go, Ansible, or Helm for deployment, see the [Go][go_examples], [Ansible][ansible_examples], or [Helm][helm_examples] samples sections, respectively.
77

88
**NOTE:** For examples of other operators, see the [Awesome Operators][awesome-operators] repo. However, note that not all of these operators were written using [operator-sdk][operator_sdk].
99

10-
[operator_sdk]:https://github.com/coreos/operator-sdk
10+
[operator_sdk]:https://github.com/operator-framework/operator-sdk
11+
[go_examples]:./go/
1112
[ansible_examples]:./ansible/
1213
[helm_examples]:./helm/
13-
[awesome-operators]:https://github.com/operator-framework/awesome-operators
14+
[awesome-operators]:https://github.com/operator-framework/awesome-operators

ansible/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ This project is a component of the [Operator Framework](https://github.com/opera
33
# Operator SDK Samples - Ansible
44
This directory contains samples of operators powered by Ansible built using the [operator-sdk][operator_sdk]. To learn more about creating an operator that leverages Ansible, check out the [Ansible user guide][ansible_user_guide].
55

6-
[operator_sdk]:https://github.com/coreos/operator-sdk
7-
[ansible_user_guide]:https://github.com/operator-framework/operator-sdk/blob/master/doc/ansible/user-guide.md
6+
[operator_sdk]:https://github.com/operator-framework/operator-sdk
7+
[ansible_user_guide]:https://sdk.operatorframework.io/docs/ansible/quickstart/

ansible/memcached-operator/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ $ sed -i "" 's|REPLACE_IMAGE|quay.io/example-inc/memcached-operator:v0.0.1|g' de
4949

5050
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.
5151

52-
Following the expected result.
52+
Following the expected result.
5353

5454
```shell
5555
$ kubectl get all -n memcached
@@ -72,19 +72,19 @@ replicaset.apps/example-memcached-memcached-b885dcc75 3 3 3
7272
replicaset.apps/memcached-operator-df88b85f7 1 1 1 36s
7373
```
7474

75-
### Uninstalling
75+
### Uninstalling
7676

7777
To uninstall all that was performed in the above step run `make uninstall`.
7878

7979
### Troubleshooting
8080

81-
Use the following command to check the operator logs.
81+
Use the following command to check the operator logs.
8282

8383
```
8484
kubectl logs deployment.apps/memcached-operator -n memcached
8585
```
8686

87-
**NOTE:** This project is configured with the environment variable `ANSIBLE_DEBUG_LOGS` as `True`, however, note that it is `False` by default.
87+
**NOTE:** This project is configured with the environment variable `ANSIBLE_DEBUG_LOGS` as `True`, however, note that it is `False` by default.
8888

8989
**NOTE** To have further information about how to develop Ansible operators with [Operator-SDK][operator_sdk] check the [Ansible User Guide for Operator-SDK][ansible-guide]
9090

@@ -97,6 +97,6 @@ See [Testing Ansible Operators with Molecule][ansible-test-guide] documentation
9797
[kubectl_tool]: https://kubernetes.io/docs/tasks/tools/install-kubectl/
9898
[docker_tool]: https://docs.docker.com/install/
9999
[operator_sdk]: https://github.com/operator-framework/operator-sdk
100-
[operator_install]: https://github.com/operator-framework/operator-sdk/blob/master/doc/user/install-operator-sdk.md
101-
[ansible-test-guide]: https://github.com/operator-framework/operator-sdk/blob/master/doc/ansible/dev/testing_guide.md
102-
[ansible-guide]: https://github.com/operator-framework/operator-sdk/blob/master/doc/ansible/user-guide.md
100+
[operator_install]: https://sdk.operatorframework.io/docs/install-operator-sdk/
101+
[ansible-test-guide]: https://sdk.operatorframework.io/docs/ansible/testing-guide/
102+
[ansible-guide]: https://sdk.operatorframework.io/docs/ansible/quickstart/

go/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ This project is a component of the [Operator Framework](https://github.com/opera
33
# Operator SDK Samples - Go
44
This directory contains samples of operators powered by Go built using the [operator-sdk][operator_sdk]. To learn more about creating an operator that leverages Golang, check out the [user guide][user_guide].
55

6-
[operator_sdk]:https://github.com/coreos/operator-sdk
7-
[user_guide]:https://github.com/operator-framework/operator-sdk/blob/master/doc/user-guide.md
6+
[operator_sdk]:https://github.com/operator-framework/operator-sdk
7+
[user_guide]:https://sdk.operatorframework.io/docs/golang/quickstart/

go/kubebuilder/memcached-operator/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,5 +87,5 @@ $ kubectl logs deployment.apps/memcached-operator-controller-manager -n memcach
8787
[docker_tool]: https://docs.docker.com/install/
8888
[kustomize]: https://github.com/kubernetes-sigs/kustomize/blob/master/docs/INSTALL.md
8989
[operator_sdk]: https://github.com/operator-framework/operator-sdk
90-
[operator_install]: https://github.com/operator-framework/operator-sdk/blob/master/doc/user/install-operator-sdk.md
90+
[operator_install]: https://sdk.operatorframework.io/docs/install-operator-sdk/
9191
[quickstart]: https://github.com/operator-framework/operator-sdk/blob/master/website/content/en/docs/kubebuilder/quickstart.md#implement-the-controller

go/memcached-operator/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ This Memcached operator is a simple example operator for the [Operator SDK][oper
66

77
## Prerequisites
88

9-
- [dep][dep_tool] version v0.5.0+.
10-
- [go][go_tool] version v1.12+.
9+
- [go][go_tool] version v1.13+.
1110
- [docker][docker_tool] version 17.03+
1211
- [kubectl][kubectl_tool] v1.14.1+
1312
- [operator-sdk][operator_install]
@@ -61,7 +60,7 @@ Run `make install` to install the operator. Check that the operator is running i
6160
Following the expected result.
6261

6362
```shell
64-
$ kubectl get all -n memcached
63+
$ kubectl get all -n memcached
6564
NAME READY STATUS RESTARTS AGE
6665
pod/example-memcached-7c4df9b7b4-lzd6j 1/1 Running 0 64s
6766
pod/example-memcached-7c4df9b7b4-wbtkz 1/1 Running 0 64s
@@ -96,11 +95,12 @@ kubectl logs deployment.apps/memcached-operator -n memcached
9695
### Running Tests
9796

9897
Run `make test-e2e` to run the integration e2e tests with different options. For
99-
more information see the [writing e2e tests](https://github.com/operator-framework/operator-sdk/blob/master/doc/test-framework/writing-e2e-tests.md) guide.
98+
more information see the [writing e2e tests][golang-e2e-tests] guide.
10099

101100
[dep_tool]: https://golang.github.io/dep/docs/installation.html
102101
[go_tool]: https://golang.org/dl/
103102
[kubectl_tool]: https://kubernetes.io/docs/tasks/tools/install-kubectl/
104103
[docker_tool]: https://docs.docker.com/install/
105104
[operator_sdk]: https://github.com/operator-framework/operator-sdk
106-
[operator_install]: https://github.com/operator-framework/operator-sdk/blob/master/doc/user/install-operator-sdk.md
105+
[operator_install]: https://sdk.operatorframework.io/docs/install-operator-sdk/
106+
[golang-e2e-tests]: https://sdk.operatorframework.io/docs/golang/e2e-tests/

helm/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ This project is a component of the [Operator Framework](https://github.com/opera
33
# Operator SDK Samples - Helm
44
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].
55

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
6+
[operator_sdk]:https://github.com/operator-framework/operator-sdk
7+
[helm_user_guide]:https://sdk.operatorframework.io/docs/helm/quickstart/

helm/memcached-operator/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,13 @@ NAME READY AGE CONTAINERS IMAGES
7878
statefulset.apps/example-memcached 3/3 37s example-memcached memcached:1.5.12-alpine
7979
```
8080

81-
### Uninstalling
81+
### Uninstalling
8282

8383
Run `make uninstall` to uninstall all that was performed in the above step.
8484

8585
### Troubleshooting
8686

87-
Run the following command to check the operator logs.
87+
Run the following command to check the operator logs.
8888

8989
```shell
9090
kubectl logs deployment.apps/memcached-operator -n helm-memcached
@@ -104,7 +104,7 @@ Note that you must have Helm installed locally and add the stable helm charts re
104104

105105
[kubectl_tool]: https://kubernetes.io/docs/tasks/tools/install-kubectl/
106106
[docker_tool]: https://docs.docker.com/install/
107-
[operator_install]: https://github.com/operator-framework/operator-sdk/blob/master/doc/user/install-operator-sdk.md
108-
[helm_guide]: https://github.com/operator-framework/operator-sdk/blob/master/doc/helm/user-guide.md
107+
[operator_install]: https://sdk.operatorframework.io/docs/install-operator-sdk/
108+
[helm_guide]: https://sdk.operatorframework.io/docs/helm/quickstart/
109109
[stable/memcached]: https://github.com/helm/charts/tree/master/stable/memcached
110110
[helm-quick]: https://helm.sh/docs/intro/quickstart/

helm/memcached-operator/helm-charts/memcached/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> [Memcached](https://memcached.org/) is an in-memory key-value store for small chunks of arbitrary data (strings, objects) from results of database calls, API calls, or page rendering.
44
5-
Based on the [memcached](https://github.com/bitnami/charts/tree/master/incubator/memcached) chart from the [Bitnami Charts](https://github.com/bitnami/charts) repository.
5+
Based on the [memcached](https://github.com/helm/charts/tree/master/stable/memcached) chart from the [Helm Charts](https://github.com/helm/charts) repository.
66

77
## TL;DR;
88

@@ -127,5 +127,3 @@ spec:
127127
```
128128

129129
Once you've done this, you can upgrade to 3.x with Helm as normal.
130-
131-

0 commit comments

Comments
 (0)