mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
97bae04edb
resolving error in HCP topic map indentation removed the < and replaced with brackets for tech preview in HCP topic map removed the < and replaced with brackets for Operators tech preview in HCP topic map removed the file with tech preview for Operators in HCP topic map applied conditions to 20 xrefs because the networking, cli, authentication and observability books are not in HCP repo yet added blank line after and endif and an include module
104 lines
6.1 KiB
Plaintext
104 lines
6.1 KiB
Plaintext
:_mod-docs-content-type: ASSEMBLY
|
|
[id="osdk-golang-tutorial"]
|
|
= Operator SDK tutorial for Go-based Operators
|
|
include::_attributes/common-attributes.adoc[]
|
|
:context: osdk-golang-tutorial
|
|
|
|
toc::[]
|
|
|
|
Operator developers can take advantage of Go programming language support in the Operator SDK to build an example Go-based Operator for Memcached, a distributed key-value store, and manage its lifecycle.
|
|
|
|
include::snippets/osdk-deprecation.adoc[]
|
|
|
|
This process is accomplished using two centerpieces of the Operator Framework:
|
|
|
|
Operator SDK:: The `operator-sdk` CLI tool and `controller-runtime` library API
|
|
|
|
Operator Lifecycle Manager (OLM):: Installation, upgrade, and role-based access control (RBAC) of Operators on a cluster
|
|
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
[NOTE]
|
|
====
|
|
This tutorial goes into greater detail than xref:../../../operators/operator_sdk/golang/osdk-golang-quickstart.adoc#osdk-golang-quickstart[Getting started with Operator SDK for Go-based Operators].
|
|
====
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
// The "Getting started" quickstarts require cluster-admin and are therefore only available in OCP.
|
|
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
[NOTE]
|
|
====
|
|
This tutorial goes into greater detail than link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-golang-quickstart[Getting started with Operator SDK for Go-based Operators] in the OpenShift Container Platform documentation.
|
|
====
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
include::modules/osdk-common-prereqs.adoc[leveloffset=+1]
|
|
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
* xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI]
|
|
// TODO-HCP remove conditions ifndef line 40 & 42 for HCP after cli_tools book is migrated
|
|
ifndef::openshift-rosa-hcp[]
|
|
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
|
|
endif::openshift-rosa-hcp[]
|
|
|
|
include::modules/osdk-create-project.adoc[leveloffset=+1]
|
|
include::modules/osdk-project-file.adoc[leveloffset=+2]
|
|
include::modules/osdk-golang-manager.adoc[leveloffset=+2]
|
|
include::modules/osdk-golang-multi-group-apis.adoc[leveloffset=+2]
|
|
|
|
include::modules/osdk-golang-create-api-controller.adoc[leveloffset=+1]
|
|
include::modules/osdk-golang-define-api.adoc[leveloffset=+2]
|
|
include::modules/osdk-golang-generate-crd.adoc[leveloffset=+2]
|
|
include::modules/osdk-about-openapi-validation.adoc[leveloffset=+3]
|
|
|
|
include::modules/osdk-golang-implement-controller.adoc[leveloffset=+1]
|
|
|
|
The next subsections explain how the controller in the example implementation watches resources and how the reconcile loop is triggered. You can skip these subsections to go directly to xref:../../../operators/operator_sdk/golang/osdk-golang-tutorial.adoc#osdk-run-operator_osdk-golang-tutorial[Running the Operator].
|
|
|
|
include::modules/osdk-golang-controller-resources.adoc[leveloffset=+2]
|
|
include::modules/osdk-golang-controller-configs.adoc[leveloffset=+2]
|
|
include::modules/osdk-golang-controller-reconcile-loop.adoc[leveloffset=+2]
|
|
include::modules/osdk-golang-controller-rbac-markers.adoc[leveloffset=+2]
|
|
|
|
include::modules/osdk-run-proxy.adoc[leveloffset=+1]
|
|
|
|
include::modules/osdk-run-operator.adoc[leveloffset=+1]
|
|
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
[role="_additional-resources"]
|
|
.Additional resources
|
|
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-run-locally_osdk-golang-tutorial[Running locally outside the cluster] (OpenShift Container Platform documentation)
|
|
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html-single/operators/index#osdk-run-deployment_osdk-golang-tutorial[Running as a deployment on the cluster] (OpenShift Container Platform documentation)
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
// In OSD/ROSA, the only applicable option for running the Operator is to bundle and deploy with OLM.
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
include::modules/osdk-run-locally.adoc[leveloffset=+2]
|
|
include::modules/osdk-run-deployment.adoc[leveloffset=+2]
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
[id="osdk-bundle-deploy-olm_{context}"]
|
|
=== Bundling an Operator and deploying with Operator Lifecycle Manager
|
|
|
|
include::modules/osdk-bundle-operator.adoc[leveloffset=+3]
|
|
include::modules/osdk-deploy-olm.adoc[leveloffset=+3]
|
|
|
|
include::modules/osdk-create-cr.adoc[leveloffset=+1]
|
|
|
|
[id="osdk-golang-tutorial-addtl-resources"]
|
|
[role="_additional-resources"]
|
|
== Additional resources
|
|
|
|
* See xref:../../../operators/operator_sdk/golang/osdk-golang-project-layout.adoc#osdk-golang-project-layout[Project layout for Go-based Operators] to learn about the directory structures created by the Operator SDK.
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
* If a xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[cluster-wide egress proxy is configured], cluster administrators can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM).
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
ifdef::openshift-dedicated,openshift-rosa[]
|
|
// TODO-HCP remove line 97 and 99 conditions and add the HCP condition to line 92 and 98 for HCP after networking book is migrated
|
|
ifndef::openshift-rosa-hcp[]
|
|
* If a xref:../../../networking/configuring-cluster-wide-proxy.adoc#configuring-a-cluster-wide-proxy[cluster-wide egress proxy is configured],
|
|
endif::openshift-rosa-hcp[]
|
|
administrators with the `dedicated-admin` role can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM).
|
|
endif::openshift-dedicated,openshift-rosa[]
|
|
|
|
|