From 0a57672aa8d51a8c367352285ae124e84cca0e81 Mon Sep 17 00:00:00 2001 From: Andrea Hoffer Date: Thu, 10 Aug 2023 11:47:19 -0400 Subject: [PATCH] OSDOCS 6451: Adding deprecation notice for deployment configs --- _topic_maps/_topic_map.yml | 2 +- .../managing-deployment-processes.adoc | 2 ++ .../deployments/what-deployments-are.adoc | 4 +++- ...eployments-comparing-deploymentconfigs.adoc | 2 ++ modules/deployments-deploymentconfigs.adoc | 2 ++ nodes/pods/nodes-pods-autoscaling.adoc | 2 +- .../prepare-to-deploy-applications-ossm.adoc | 2 +- snippets/deployment-config-deprecated.adoc | 18 ++++++++++++++++++ 8 files changed, 30 insertions(+), 4 deletions(-) create mode 100644 snippets/deployment-config-deprecated.adoc diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 09bbf21aa6bb..955bde4f7b43 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -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 diff --git a/applications/deployments/managing-deployment-processes.adoc b/applications/deployments/managing-deployment-processes.adoc index 5226f871c93a..862d02091536 100644 --- a/applications/deployments/managing-deployment-processes.adoc +++ b/applications/deployments/managing-deployment-processes.adoc @@ -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] diff --git a/applications/deployments/what-deployments-are.adoc b/applications/deployments/what-deployments-are.adoc index 66d123c1d4e9..0900fe6263c5 100644 --- a/applications/deployments/what-deployments-are.adoc +++ b/applications/deployments/what-deployments-are.adoc @@ -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 @@ -14,6 +14,8 @@ The `Deployment` and `DeploymentConfig` API objects in {product-title} provide t 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"] diff --git a/modules/deployments-comparing-deploymentconfigs.adoc b/modules/deployments-comparing-deploymentconfigs.adoc index d833b3ff940f..11c2f19dc6bb 100644 --- a/modules/deployments-comparing-deploymentconfigs.adoc +++ b/modules/deployments-comparing-deploymentconfigs.adoc @@ -9,6 +9,8 @@ Both Kubernetes `Deployment` objects and {product-title}-provided `DeploymentCon 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 diff --git a/modules/deployments-deploymentconfigs.adoc b/modules/deployments-deploymentconfigs.adoc index 63f5468a15b9..a0537f7bc096 100644 --- a/modules/deployments-deploymentconfigs.adoc +++ b/modules/deployments-deploymentconfigs.adoc @@ -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. diff --git a/nodes/pods/nodes-pods-autoscaling.adoc b/nodes/pods/nodes-pods-autoscaling.adoc index 3b9286938fee..c87ce96584e8 100644 --- a/nodes/pods/nodes-pods-autoscaling.adoc +++ b/nodes/pods/nodes-pods-autoscaling.adoc @@ -18,7 +18,7 @@ For information on scaling pods based on custom metrics, see xref:../../nodes/cm [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 diff --git a/service_mesh/v2x/prepare-to-deploy-applications-ossm.adoc b/service_mesh/v2x/prepare-to-deploy-applications-ossm.adoc index bfb37a3c9b85..c3024d1ef908 100644 --- a/service_mesh/v2x/prepare-to-deploy-applications-ossm.adoc +++ b/service_mesh/v2x/prepare-to-deploy-applications-ossm.adoc @@ -11,7 +11,7 @@ After adding the namespaces that contain your services to your mesh, the next st 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 diff --git a/snippets/deployment-config-deprecated.adoc b/snippets/deployment-config-deprecated.adoc new file mode 100644 index 000000000000..0e3fc5d1e067 --- /dev/null +++ b/snippets/deployment-config-deprecated.adoc @@ -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. +====