Merge pull request #77128 from michaelryanpeter/osdocs-10523-deprecate-operator-sdk

OSDOCS#10534: Deprecate Operator SDK and related scaffolidng

Author: michaelryanpeter

cli_reference/osdk/cli-osdk-install.adoc

@@ -8,6 +8,8 @@ toc::[]
 
 The Operator SDK provides a command-line interface (CLI) tool that Operator developers can use to build, test, and deploy an Operator. You can install the Operator SDK CLI on your workstation so that you are prepared to start authoring your own Operators.
 
+include::snippets/osdk-deprecation.adoc[]
+
 Operator authors with cluster administrator access to a Kubernetes-based cluster, such as {product-title}, can use the Operator SDK CLI to develop their own Operators based on Go, Ansible, Java, or Helm. link:https://kubebuilder.io/[Kubebuilder] is embedded into the Operator SDK as the scaffolding solution for Go-based Operators, which means existing Kubebuilder projects can be used as is with the Operator SDK and continue to work.
 ifndef::openshift-rosa,openshift-dedicated[]
 See xref:../../operators/operator_sdk/osdk-about.adoc#osdk-about[Developing Operators] for full documentation on the Operator SDK.
@@ -20,4 +22,4 @@ endif::openshift-rosa,openshift-dedicated[]
 
 include::modules/osdk-installing-cli-linux-macos.adoc[leveloffset=+1]
 
-include::modules/osdk-installing-cli-macos.adoc[leveloffset=+1]
+include::modules/osdk-installing-cli-macos.adoc[leveloffset=+1]

cli_reference/osdk/cli-osdk-ref.adoc

@@ -8,6 +8,8 @@ toc::[]
 
 The Operator SDK command-line interface (CLI) is a development kit designed to make writing Operators easier.
 
+include::snippets/osdk-deprecation.adoc[]
+
 .Operator SDK CLI syntax
 [source,terminal]
 ----
@@ -51,4 +53,4 @@ ifndef::openshift-rosa,openshift-dedicated[]
 .Additional resources
 
 * See xref:../../operators/operator_sdk/osdk-scorecard.adoc#osdk-scorecard[Validating Operators using the scorecard tool] for details about running the scorecard tool.
-endif::openshift-rosa,openshift-dedicated[]
+endif::openshift-rosa,openshift-dedicated[]

operators/operator_sdk/ansible/osdk-ansible-cr-status.adoc

@@ -6,5 +6,7 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
+include::snippets/osdk-deprecation.adoc[]
+
 include::modules/osdk-ansible-cr-status-about.adoc[leveloffset=+1]
 include::modules/osdk-ansible-cr-status-manual.adoc[leveloffset=+1]

operators/operator_sdk/ansible/osdk-ansible-inside-operator.adoc

@@ -8,6 +8,8 @@ toc::[]
 
 After you are familiar with xref:../../../operators/operator_sdk/ansible/osdk-ansible-k8s-collection.adoc#osdk-ansible-k8s-collection[using the Kubernetes Collection for Ansible locally], you can trigger the same Ansible logic inside of an Operator when a custom resource (CR) changes. This example maps an Ansible role to a specific Kubernetes resource that the Operator watches. This mapping is done in the `watches.yaml` file.
 
+include::snippets/osdk-deprecation.adoc[]
+
 include::modules/osdk-ansible-custom-resource-files.adoc[leveloffset=+1]
 include::modules/osdk-ansible-inside-operator-local.adoc[leveloffset=+1]
 include::modules/osdk-run-deployment.adoc[leveloffset=+1]

operators/operator_sdk/ansible/osdk-ansible-k8s-collection.adoc

@@ -8,6 +8,8 @@ toc::[]
 
 To manage the lifecycle of your application on Kubernetes using Ansible, you can use the link:https://galaxy.ansible.com/community/kubernetes[Kubernetes Collection for Ansible]. This collection of Ansible modules allows a developer to either leverage their existing Kubernetes resource files written in YAML or express the lifecycle management in native Ansible.
 
+include::snippets/osdk-deprecation.adoc[]
+
 One of the biggest benefits of using Ansible in conjunction with existing Kubernetes resource files is the ability to use Jinja templating so that you can customize resources with the simplicity of a few variables in Ansible.
 
 This section goes into detail on usage of the Kubernetes Collection. To get started, install the collection on your local workstation and test it using a playbook before moving on to using it within an Operator.

operators/operator_sdk/ansible/osdk-ansible-project-layout.adoc

@@ -8,4 +8,6 @@ toc::[]
 
 The `operator-sdk` CLI can generate, or _scaffold_, a number of packages and files for each Operator project.
 
+include::snippets/osdk-deprecation.adoc[]
+
 include::modules/osdk-ansible-project-layout.adoc[leveloffset=+1]

operators/operator_sdk/ansible/osdk-ansible-quickstart.adoc

@@ -10,6 +10,8 @@ toc::[]
 
 The Operator SDK includes options for generating an Operator project that leverages existing Ansible playbooks and modules to deploy Kubernetes resources as a unified application, without having to write any Go code.
 
+include::snippets/osdk-deprecation.adoc[]
+
 To demonstrate the basics of setting up and running an link:https://docs.ansible.com/ansible/latest/index.html[Ansible]-based Operator using tools and libraries provided by the Operator SDK, Operator developers can build an example Ansible-based Operator for Memcached, a distributed key-value store, and deploy it to a cluster.
 
 include::modules/osdk-common-prereqs.adoc[leveloffset=+1]

operators/operator_sdk/ansible/osdk-ansible-support.adoc

@@ -6,6 +6,8 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
+include::snippets/osdk-deprecation.adoc[]
+
 include::modules/osdk-ansible-custom-resource-files.adoc[leveloffset=+1]
 include::modules/osdk-ansible-watches-file.adoc[leveloffset=+1]
 include::modules/osdk-ansible-extra-variables.adoc[leveloffset=+1]

operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc

@@ -12,6 +12,8 @@ Operator developers can take advantage of link:https://docs.ansible.com/ansible/
 * Ensure that the deployment size is the same as specified by the `Memcached` custom resource (CR) spec
 * Update the `Memcached` CR status using the status writer with the names of the `memcached` pods
 
+include::snippets/osdk-deprecation.adoc[]
+
 This process is accomplished by using two centerpieces of the Operator Framework:
 
 Operator SDK:: The `operator-sdk` CLI tool and `controller-runtime` library API

operators/operator_sdk/ansible/osdk-ansible-updating-projects.adoc

@@ -8,6 +8,8 @@ toc::[]
 
 {product-title} {product-version} supports Operator SDK {osdk_ver}. If you already have the {osdk_ver_n1} CLI installed on your workstation, you can update the CLI to {osdk_ver} by xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[installing the latest version].
 
+include::snippets/osdk-deprecation.adoc[]
+
 However, to ensure your existing Operator projects maintain compatibility with Operator SDK {osdk_ver}, update steps are required for the associated breaking changes introduced since {osdk_ver_n1}. You must perform the update steps manually in any of your Operator projects that were previously created or maintained with {osdk_ver_n1}.
 
 include::modules/osdk-updating-128-to-131.adoc[leveloffset=+1]