OSDOCS 6451: Adding deprecation notice for deployment configs #63529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

bergerhoffer merged 1 commit into openshift:main from bergerhoffer:OSDOCS-6451

Aug 30, 2023

_topic_maps/_topic_map.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -2106,7 +2106,7 @@ Topics: @@
     - Name: Deployments
       Dir: deployments
       Topics:
-      - Name: Understanding Deployments and DeploymentConfigs
+      - Name: Understanding deployments
         File: what-deployments-are
       - Name: Managing deployment processes
         File: managing-deployment-processes
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,8 @@ toc::[] @@
     [id="deploymentconfig-operations"]
     == Managing DeploymentConfig objects
+    include::snippets/deployment-config-deprecated.adoc[]
     `DeploymentConfig` objects can be managed from the {product-title} web console's *Workloads* page or using the `oc` CLI. The following procedures show CLI usage unless otherwise stated.
     include::modules/deployments-starting-deployment.adoc[leveloffset=+2]
@@ Expand Down @@

applications/deployments/what-deployments-are.adoc

-Original file line number
+Diff line change
@@ -1,6 +1,6 @@
     :_content-type: ASSEMBLY
     [id="what-deployments-are"]
-    = Understanding Deployment and DeploymentConfig objects
+    = Understanding deployments
     include::_attributes/common-attributes.adoc[]
     :context: what-deployments-are
@@ Expand All @@
     Use `Deployment` objects unless you need a specific feature or behavior provided by `DeploymentConfig` objects.
+    include::snippets/deployment-config-deprecated.adoc[]
     ////
     Update when converted:
     [role="_additional-resources"]
@@ Expand Down @@

modules/deployments-comparing-deploymentconfigs.adoc

-Original file line number
+Diff line change
@@ Expand Up @@
     The following sections go into more detail on the differences between the two object types to further help you decide which type to use.
+    include::snippets/deployment-config-deprecated.adoc[]
     [id="deployments-design_{context}"]
     == Design
@@ Expand Down @@

modules/deployments-deploymentconfigs.adoc

-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,8 @@ @@
     [id="deployments-and-deploymentconfigs_{context}"]
     = DeploymentConfig objects
+    include::snippets/deployment-config-deprecated.adoc[]
     Building on replication controllers, {product-title} adds expanded support for the software development and deployment lifecycle with the concept of `DeploymentConfig` objects. In the simplest case, a `DeploymentConfig` object creates a new replication controller and lets it start up pods.
     However, {product-title} deployments from `DeploymentConfig` objects also provide the ability to transition from an existing deployment of an image to a new one and also define hooks to be run before or after creating the replication controller.
@@ Expand Down @@

nodes/pods/nodes-pods-autoscaling.adoc

-Original file line number
+Diff line change
@@ Expand Up @@
     [NOTE]
     ====
     It is recommended to use a `Deployment` object or `ReplicaSet` object unless you need a specific feature or behavior provided by other objects. For more information on
-    these objects, see xref:../../applications/deployments/what-deployments-are.adoc#what-deployments-are[Understanding Deployment and DeploymentConfig objects].
+    these objects, see xref:../../applications/deployments/what-deployments-are.adoc#what-deployments-are[Understanding deployments].
     ====
     // The following include statements pull in the module files that comprise
@@ Expand Down @@

service_mesh/v2x/prepare-to-deploy-applications-ossm.adoc

-Original file line number
+Diff line change
@@ Expand Up @@
     If you have installed the Bookinfo sample application, the application was deployed and the sidecars were injected as part of the installation procedure. If you are using your own project and service, deploy your applications on {product-title}.
     ifdef::openshift-enterprise[]
-    For more information, see the {product-title} documentation, xref:../../applications/deployments/what-deployments-are.adoc[Understanding Deployment and DeploymentConfig objects].
+    For more information, see the {product-title} documentation, xref:../../applications/deployments/what-deployments-are.adoc[Understanding deployments].
     endif::[]
     == Prerequisites
@@ Expand Down @@

snippets/deployment-config-deprecated.adoc

-Original file line number
+Diff line change
@@ -0,0 +1,18 @@
+    // Text snippet included in the following assemblies:
+    //
+    // * applications/deployments/what-deployments-are.adoc
+    // * applications/deployments/managing-deployment-processes.adoc
+    //
+    // Text snippet included in the following modules:
+    //
+    // * modules/deployments-deploymentconfigs.adoc
+    // * modules/deployments-comparing-deploymentconfigs.adoc
+    :_content-type: SNIPPET
+    [IMPORTANT]
+    ====
+    As of {product-title} 4.14, `DeploymentConfig` objects are deprecated. `DeploymentConfig` objects are still supported, but are not recommended for new installations. Only security-related and critical issues will be fixed.
+    Instead, use `Deployment` objects or another alternative to provide declarative updates for pods.
+    ====

Provide feedback