Skip to content

Commit 79b8a2e

Browse files
doc: apply small fixes perform on master on to the migration guide (0.19) (#3516)
- Closes: #3396 - Closes: #3512
1 parent 5c898e4 commit 79b8a2e

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

website/content/en/docs/golang/project_migration_guide.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ The document considers [memcached operator][memcached-operator] as an example to
1212

1313
## Prerequisites
1414
- [git][git_tool].
15-
- [go][go_tool] version 17.03+.
15+
- [go][go_tool] version 1.13+.
16+
- [docker][docker_tool] version 17.03+.
1617
- [kubectl][kubectl_tool] version v1.11.3+.
1718
- [kustomize][kustomize_tool] v3.1.0+.
1819
- Access to a Kubernetes v1.11.3+ cluster.
@@ -57,7 +58,7 @@ Create a new API and its corresponding controller.
5758

5859
In case of memcached operator, a new API for kind `Memcached` and group/version `cache/v1aplha1` is created using the following command.
5960

60-
`operator-sdk api --group cache --version v1alpha1 --kind Memcached`
61+
`operator-sdk create api --group cache --version v1alpha1 --kind Memcached`
6162

6263
Press `y` when asked for creating resource and controller. This will scaffold the project and create the files `api/<version>/<kind>_types.go` and `controller/<kind>_types.go`.
6364

@@ -81,7 +82,7 @@ type MemcachedStatus struct {
8182
}
8283
```
8384
**Note**:
84-
If there are any any libraries or pkgs present in `pkg/apis/cache/v1alpha1`, copy them over to `api/v1alpha1`.
85+
If there are any libraries or pkgs present in `pkg/apis/cache/v1alpha1`, copy them over to `api/v1alpha1`.
8586

8687
### CRD markers
8788

@@ -152,12 +153,13 @@ func (r *MemcachedReconciler) Reconcile(req ctrl.Request) (ctrl.Result, error) {
152153
**Note**:
153154
To update `config/rbac/role.yaml` after changing the markers, run `make manifests`.
154155
155-
The project can now be built and the operator can be deployed on cluster. For further steps regarding the deployment of operator, creation of custom resource and cleaning up of resources, refer to [quickstart guide][kb_quickstart].
156+
The project can now be built, and the operator can be deployed on-cluster. For further steps regarding the deployment of the operator, creation of custom resources and cleaning up of resources, refer to the [quickstart guide][kb_quickstart].
156157
157158
158159
[memcached-operator]:/docs/golang/quickstart/
159160
[git_tool]: https://git-scm.com/downloads
160161
[go_tool]: https://golang.org/dl/
162+
[docker_tool]:https://docs.docker.com/install/
161163
[kubectl_tool]: https://github.com/kubernetes/minikube#installation
162164
[kustomize_tool]: https://github.com/kubernetes-sigs/kustomize/blob/master/docs/INSTALL.md
163165
[kubebuilder_install]: https://book.kubebuilder.io/quick-start.html#installation
@@ -168,6 +170,6 @@ The project can now be built and the operator can be deployed on cluster. For fu
168170
[rbac_markers]: https://book.kubebuilder.io/reference/markers/rbac.html
169171
[memcached_cr]: https://github.com/operator-framework/operator-sdk-samples/blob/master/go/memcached-operator/deploy/crds/cache.example.com_v1alpha1_memcached_cr.yaml
170172
[memcached_types]: https://github.com/operator-framework/operator-sdk-samples/blob/master/go/memcached-operator/pkg/apis/cache/v1alpha1/memcached_types.go
171-
[kb_memcached_controller]: https://github.com/operator-framework/operator-sdk/blob/master/example/kb-memcached-operator/memcached_controller.go.tmpl
173+
[kb_memcached_controller]: https://github.com/operator-framework/operator-sdk/blob/v0.19.x/example/kb-memcached-operator/memcached_controller.go.tmpl
172174
[kb_quickstart]: /docs/golang/quickstart/
173175
[install_guide]: /docs/install-operator-sdk/

website/content/en/docs/migration/v0.19.0.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ _See [#3265](https://github.com/operator-framework/operator-sdk/pull/3265) for m
2222

2323
## Migrating Go projects to the new Kubebuilder aligned project layout
2424

25-
See the [migration guide](https://master.sdk.operatorframework.io/docs/golang/project_migration_guide/)
25+
See the [migration guide][migration-guide][migration-guide]
2626
that walks through an example of how to migrate a Go based operator project from the old layout to the new layout.
2727

2828
_See [#3190](https://github.com/operator-framework/operator-sdk/pull/3190) for more details._
@@ -46,3 +46,5 @@ However, any script or code that is depending on this condition reason must be u
4646
to use `UpgradeError` instead of `UpdateError`.
4747

4848
_See [#3269](https://github.com/operator-framework/operator-sdk/pull/3269) for more details._
49+
50+
[migration-guide]: /docs/golang/project_migration_guide

0 commit comments

Comments
 (0)