Skip to content

Commit 3faedeb

Browse files
committed
Breakup deployments.adoc into subdir
1 parent c220a8f commit 3faedeb

20 files changed

+1317
-1275
lines changed

_topic_map.yml

+10-1
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,16 @@ Topics:
606606
- Name: Quotas and Limit Ranges
607607
File: compute_resources
608608
- Name: Deployments
609-
File: deployments
609+
Dir: deployments
610+
Topics:
611+
- Name: How Deployments Work
612+
File: how_deployments_work
613+
- Name: Basic Deployment Operations
614+
File: basic_deployment_operations
615+
- Name: Deployment Strategies
616+
File: deployment_strategies
617+
- Name: Advanced Deployment Strategies
618+
File: advanced_deployment_strategies
610619
- Name: Getting Traffic Into The Cluster
611620
File: getting_traffic_into_cluster
612621
- Name: Routes

admin_guide/managing_pods.adoc

+3-4
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,9 @@ ifdef::openshift-enterprise,openshift-origin[]
8484
[[manage-pods-limit-run-once-duration]]
8585
== Limiting Run-once Pod Duration
8686

87-
{product-title} relies on run-once pods to perform tasks such as
88-
xref:../dev_guide/deployments.adoc#dev-guide-deployments[deploying a pod] or
89-
xref:../dev_guide/builds.adoc#dev-guide-builds[performing a build]. Run-once pods are pods that
90-
have a `*RestartPolicy*` of `Never` or `OnFailure`.
87+
{product-title} relies on run-once pods to perform tasks such as deploying a pod
88+
or performing a build. Run-once pods are pods that have a `*RestartPolicy*` of
89+
`Never` or `OnFailure`.
9190

9291
The cluster administrator can use the *RunOnceDuration* admission control
9392
plug-in to force a limit on the time that those run-once pods can be active.

admin_guide/managing_projects.adoc

+1-2
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,7 @@ the entire cluster.
214214
=== Developer-specified Node Selectors
215215

216216
{product-title} developers
217-
xref:../dev_guide/deployments.adoc#assigning-pods-to-specific-nodes[can set a
218-
node selector on their pod configuration] if they wish to restrict nodes even
217+
xref:../dev_guide/deployments/basic_deployment_operations.adoc#assigning-pods-to-specific-nodes[can set a node selector on their pod configuration] if they wish to restrict nodes even
219218
further. This will be in addition to the project node selector, meaning that you
220219
can still dictate node selector values for all projects that have a node
221220
selector value.

admin_guide/quota.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -465,6 +465,6 @@ ifdef::openshift-origin,openshift-enterprise,openshift-dedicated[]
465465
== Accounting for Quota in Deployment Configurations
466466

467467
If a quota has been defined for your project, see
468-
xref:../dev_guide/deployments.adoc#deployment-resources[Deployment Resources]
468+
xref:../dev_guide/deployments/basic_deployment_operations.adoc#deployment-resources[Deployment Resources]
469469
for considerations on any deployment configurations.
470470
endif::[]

architecture/core_concepts/deployments.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ When a deployment is superseded by another, the previous replication
141141
controller is retained to enable easy rollback if needed.
142142

143143
For detailed instructions on how to create and interact with deployments,
144-
refer to xref:../../dev_guide/deployments.adoc#dev-guide-deployments[Deployments].
144+
refer to xref:../../dev_guide/deployments/basic_deployment_operations.adoc#dev-guide-basic-deployment-operations[Deployments].
145145

146146
Here is an example `*DeploymentConfiguration*` definition with some
147147
omissions and callouts:

cli_reference/basic_cli_operations.adoc

+9-10
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ $ oc delete all -l <label>
258258
----
259259

260260
=== set
261-
Modify a specific property of the specified object.
261+
Modify a specific property of the specified object.
262262

263263
==== set env
264264
Sets an environment variable on a deployment configuration or a build configuration:
@@ -279,9 +279,9 @@ $ oc set build-secret --source bc/mybc mysecret
279279
One of the fundamental capabilities of {product-title} is the ability to build
280280
applications into a container from source.
281281

282-
{product-title} provides CLI access to inspect and manipulate
283-
xref:../dev_guide/deployments.adoc#dev-guide-deployments[deployment configurations] using standard
284-
`oc` resource operations, such as `get`, `create`, and `describe`.
282+
{product-title} provides CLI access to inspect and manipulate deployment
283+
configurations using standard `oc` resource operations, such as `get`, `create`,
284+
and `describe`.
285285

286286
=== start-build
287287
Manually start the build process with the specified build configuration file:
@@ -358,15 +358,15 @@ $ oc start-build --list-webhooks
358358
----
359359

360360
=== deploy
361-
View a xref:../dev_guide/deployments.adoc#dev-guide-deployments[deployment], or manually start,
362-
cancel, or retry a deployment:
361+
View a deployment, or manually start, cancel, or retry a deployment:
362+
363363
----
364364
$ oc deploy <deploymentconfig>
365365
----
366366

367367
=== rollback
368368
Perform a
369-
xref:../dev_guide/deployments.adoc#rolling-back-a-deployment[rollback]:
369+
xref:../dev_guide/deployments/basic_deployment_operations.adoc#rolling-back-a-deployment[rollback]:
370370
----
371371
$ oc rollback <deployment_name>
372372
----
@@ -408,9 +408,8 @@ $ oc import-image <image_stream>
408408

409409
=== scale
410410
Set the number of desired replicas for a
411-
xref:../architecture/core_concepts/deployments.adoc#replication-controllers[replication
412-
controller] or a xref:../dev_guide/deployments.adoc#dev-guide-deployments[deployment configuration] to
413-
the number of specified replicas:
411+
xref:../architecture/core_concepts/deployments.adoc#replication-controllers[replication controller] or a deployment configuration to the number of specified replicas:
412+
414413
----
415414
$ oc scale <object_type> <object_name> --replicas=<#_of_replicas>
416415
----

dev_guide/app_tutorials/ruby_on_rails.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ $ oc new-app path/to/source/code --name=rails-app -e POSTGRESQL_USER=username -e
301301

302302
With this command, {product-title} fetches the source code, sets up the Builder image, xref:../builds.adoc#dev-guide-builds[builds] your application image, and deploys the newly created image together with the specified xref:../../using_images/db_images/postgresql.adoc#postgresql-environment-variables[environment variables]. The application is named `rails-app`.
303303

304-
You can verify the environment variables have been added by viewing the JSON document of the `rails-app` xref:../deployments.adoc#dev-guide-deployments[DeploymentConfig]:
304+
You can verify the environment variables have been added by viewing the JSON document of the `rails-app` xref:../deployments/how_deployments_work.adoc#dev-guide-how-deployments-work[DeploymentConfig]:
305305

306306
----
307307
$ oc get dc rails-app -o json
@@ -354,7 +354,7 @@ Run the migration from inside the container:
354354

355355
If you are running your Rails application in a `development` or `test` environment you don't have to specify the `RAILS_ENV` environment variable.
356356

357-
* By adding pre-deployment xref:../../dev_guide/deployments.adoc#lifecycle-hooks[lifecycle hooks] in your template. For example check the link:https://github.com/openshift/rails-ex/blob/master/openshift/templates/rails-postgresql.json#L122-L130[hooks example] in our link:https://github.com/openshift/rails-ex[Rails example] application.
357+
* By adding pre-deployment xref:../../dev_guide/deployments/deployment_strategies.adoc#lifecycle-hooks[lifecycle hooks] in your template. For example check the link:https://github.com/openshift/rails-ex/blob/master/openshift/templates/rails-postgresql.json#L122-L130[hooks example] in our link:https://github.com/openshift/rails-ex[Rails example] application.
358358

359359
=== Creating a Route for Your Application
360360

0 commit comments

Comments
 (0)