-
Notifications
You must be signed in to change notification settings - Fork 1.9k
OSDOCS-17161-2:(CQA) APP-2: Deployments - Attachment3 #117477
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -6,7 +6,8 @@ | |||||||||
| [id="deployments-accessing-private-repos_{context}"] | ||||||||||
| = Accessing private repositories from DeploymentConfig objects | ||||||||||
|
|
||||||||||
| You can add a secret to your `DeploymentConfig` object so that it can access images from a private repository. This procedure shows the {product-title} web console method. | ||||||||||
| [role="_abstract"] | ||||||||||
| To pull container images from a private repository into a `DeploymentConfig` object in {product-title}, you can add a pull secret. Create the secret in the web console, then set it as the pull secret on the `DeploymentConfig` object. | ||||||||||
|
Comment on lines
+9
to
+10
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Wanted to add a bit of clarity as to where the pull secret goes (the repository vs object). And is it in or on an object?
Suggested change
|
||||||||||
|
|
||||||||||
| .Procedure | ||||||||||
|
|
||||||||||
|
|
||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -6,6 +6,7 @@ | |||||||||
| [id="deployments-rolling-back_{context}"] | ||||||||||
| = Rolling back a deployment | ||||||||||
|
|
||||||||||
| [role="_abstract"] | ||||||||||
| Rollbacks revert an application back to a previous revision and can be performed using the REST API, the CLI, or the web console. | ||||||||||
|
Comment on lines
+9
to
10
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would this be stronger in the active voice?
Suggested change
|
||||||||||
|
|
||||||||||
| .Procedure | ||||||||||
|
|
||||||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -6,6 +6,9 @@ | |||||
| [id="deployments-setting-resources_{context}"] | ||||||
| = Setting deployment resources | ||||||
|
|
||||||
| [role="_abstract"] | ||||||
| To limit CPU, memory, and ephemeral storage used by a deployment in {product-title}, you can set resource limits on the deployment strategy. Define limits in the `resources` section so deployer pods do not consume unbounded node capacity. | ||||||
|
|
||||||
| A deployment is completed by a pod that consumes resources (memory, CPU, and ephemeral storage) on a node. By default, pods consume unbounded node resources. However, if a project specifies default container limits, then pods consume resources up to those limits. | ||||||
|
|
||||||
| [NOTE] | ||||||
|
|
@@ -31,13 +34,13 @@ spec: | |||||
| type: "Recreate" | ||||||
| resources: | ||||||
| limits: | ||||||
| cpu: "100m" <1> | ||||||
| memory: "256Mi" <2> | ||||||
| cpu: "100m" | ||||||
| memory: "256Mi" | ||||||
| ephemeral-storage: "1Gi" <3> | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| ---- | ||||||
| <1> `cpu` is in CPU units: `100m` represents 0.1 CPU units (100 * 1e-3). | ||||||
| <2> `memory` is in bytes: `256Mi` represents 268435456 bytes (256 * 2 ^ 20). | ||||||
| <3> `ephemeral-storage` is in bytes: `1Gi` represents 1073741824 bytes (2 ^ 30). | ||||||
| * `spec.resources.limits.cpu` specifies the CPU units: `100m` represents 0.1 CPU units (100 * 1e-3). | ||||||
| * `spec.resources.limits.memory` specifies the bytes for memory: `256Mi` represents 268435456 bytes (256 * 2 ^ 20). | ||||||
| * `spec.resources.limits.ephemeral-storage` specifies the bytes for ephemeral-storage: `1Gi` represents 1073741824 bytes (2 ^ 30). | ||||||
| + | ||||||
| However, if a quota has been defined for your project, one of the following two items is required: | ||||||
| + | ||||||
|
|
@@ -55,12 +58,13 @@ spec: | |||||
| # ... | ||||||
| type: "Recreate" | ||||||
| resources: | ||||||
| requests: <1> | ||||||
| requests: | ||||||
| cpu: "100m" | ||||||
| memory: "256Mi" | ||||||
| ephemeral-storage: "1Gi" | ||||||
| ---- | ||||||
| <1> The `requests` object contains the list of resources that correspond to the list of resources in the quota. | ||||||
| + | ||||||
| The `spec.resources.requests` object contains the list of resources that correspond to the list of resources in the quota. | ||||||
|
|
||||||
| - A limit range defined in your project, where the defaults from the `LimitRange` object apply to pods created during the deployment process. | ||||||
| -- | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -6,7 +6,8 @@ | |||||||||
| [id="deployments-triggers_{context}"] | ||||||||||
| = Deployment triggers | ||||||||||
|
|
||||||||||
| A `DeploymentConfig` object can contain triggers, which drive the creation of new deployment processes in response to events inside the cluster. | ||||||||||
| [role="_abstract"] | ||||||||||
| A deployment trigger on a `DeploymentConfig` object in {product-title} starts a new deployment process when cluster events occur. Use config change or image change triggers to roll out automatically, or leave triggers empty if you want to start deployments only manually. | ||||||||||
|
Comment on lines
+9
to
+10
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. only manually sounds odd to me.
Suggested change
|
||||||||||
|
|
||||||||||
| [WARNING] | ||||||||||
| ==== | ||||||||||
|
|
@@ -55,15 +56,15 @@ spec: | |||||||||
| triggers: | ||||||||||
| - type: "ImageChange" | ||||||||||
| imageChangeParams: | ||||||||||
| automatic: true <1> | ||||||||||
| automatic: true | ||||||||||
| from: | ||||||||||
| kind: "ImageStreamTag" | ||||||||||
| name: "origin-ruby-sample:latest" | ||||||||||
| namespace: "myproject" | ||||||||||
| containerNames: | ||||||||||
| - "helloworld" | ||||||||||
| ---- | ||||||||||
| <1> If the `imageChangeParams.automatic` field is set to `false`, the trigger is disabled. | ||||||||||
| If the `triggers.imageChangeParams.automatic` field is set to `false`, the trigger is disabled. | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Should we rewrite this so that it matches what is in the example? I don't think that would trigger QE review.
Suggested change
|
||||||||||
|
|
||||||||||
| With the above example, when the `latest` tag value of the `origin-ruby-sample` image stream changes and the new image value differs from the current image specified in the `DeploymentConfig` object's `helloworld` container, a new replication controller is created using the new image for the `helloworld` container. | ||||||||||
|
|
||||||||||
|
|
||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The following procedures isn't relevant to the short desc. I wonder, too, if this would be better in the active voice? And, we can sneak in a fairly weak why statement with depending on your preference.