Skip to content

Commit ac3b673

Browse files
authored
Merge pull request #63529 from bergerhoffer/OSDOCS-6451
OSDOCS 6451: Adding deprecation notice for deployment configs
2 parents 89c621d + 0a57672 commit ac3b673

8 files changed

+30
-4
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2113,7 +2113,7 @@ Topics:
21132113
- Name: Deployments
21142114
Dir: deployments
21152115
Topics:
2116-
- Name: Understanding Deployments and DeploymentConfigs
2116+
- Name: Understanding deployments
21172117
File: what-deployments-are
21182118
- Name: Managing deployment processes
21192119
File: managing-deployment-processes

applications/deployments/managing-deployment-processes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ toc::[]
99
[id="deploymentconfig-operations"]
1010
== Managing DeploymentConfig objects
1111

12+
include::snippets/deployment-config-deprecated.adoc[]
13+
1214
`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.
1315

1416
include::modules/deployments-starting-deployment.adoc[leveloffset=+2]

applications/deployments/what-deployments-are.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: ASSEMBLY
22
[id="what-deployments-are"]
3-
= Understanding Deployment and DeploymentConfig objects
3+
= Understanding deployments
44
include::_attributes/common-attributes.adoc[]
55
:context: what-deployments-are
66

@@ -14,6 +14,8 @@ The `Deployment` and `DeploymentConfig` API objects in {product-title} provide t
1414
1515
Use `Deployment` objects unless you need a specific feature or behavior provided by `DeploymentConfig` objects.
1616

17+
include::snippets/deployment-config-deprecated.adoc[]
18+
1719
////
1820
Update when converted:
1921
[role="_additional-resources"]

modules/deployments-comparing-deploymentconfigs.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Both Kubernetes `Deployment` objects and {product-title}-provided `DeploymentCon
99

1010
The following sections go into more detail on the differences between the two object types to further help you decide which type to use.
1111

12+
include::snippets/deployment-config-deprecated.adoc[]
13+
1214
[id="deployments-design_{context}"]
1315
== Design
1416

modules/deployments-deploymentconfigs.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
[id="deployments-and-deploymentconfigs_{context}"]
66
= DeploymentConfig objects
77

8+
include::snippets/deployment-config-deprecated.adoc[]
9+
810
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.
911

1012
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.

nodes/pods/nodes-pods-autoscaling.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For information on scaling pods based on custom metrics, see xref:../../nodes/cm
1818
[NOTE]
1919
====
2020
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
21-
these objects, see xref:../../applications/deployments/what-deployments-are.adoc#what-deployments-are[Understanding Deployment and DeploymentConfig objects].
21+
these objects, see xref:../../applications/deployments/what-deployments-are.adoc#what-deployments-are[Understanding deployments].
2222
====
2323

2424
// The following include statements pull in the module files that comprise

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ After adding the namespaces that contain your services to your mesh, the next st
1111
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}.
1212

1313
ifdef::openshift-enterprise[]
14-
For more information, see the {product-title} documentation, xref:../../applications/deployments/what-deployments-are.adoc[Understanding Deployment and DeploymentConfig objects].
14+
For more information, see the {product-title} documentation, xref:../../applications/deployments/what-deployments-are.adoc[Understanding deployments].
1515
endif::[]
1616

1717
== Prerequisites
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Text snippet included in the following assemblies:
2+
//
3+
// * applications/deployments/what-deployments-are.adoc
4+
// * applications/deployments/managing-deployment-processes.adoc
5+
//
6+
// Text snippet included in the following modules:
7+
//
8+
// * modules/deployments-deploymentconfigs.adoc
9+
// * modules/deployments-comparing-deploymentconfigs.adoc
10+
11+
:_content-type: SNIPPET
12+
13+
[IMPORTANT]
14+
====
15+
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.
16+
17+
Instead, use `Deployment` objects or another alternative to provide declarative updates for pods.
18+
====

0 commit comments

Comments
 (0)