Refine deployment docs, add advanced strategies #2890

0xmichalis · 2016-09-22T11:40:55Z

@mfojtik I would like this merged before we proceed with https://trello.com/c/oAlPryPh/793-3-need-to-document-how-to-use-upstream-deployments

@smarterclayton this squashes https://github.com/openshift/origin/blob/master/examples/deployment/README.md in openshift-docs.

mfojtik · 2016-09-23T10:11:12Z

dev_guide/deployments.adoc

+deployment configurations are propagated appropriately. If the existing
+deployment strategies are not suited for your use-case and you have the
+need to run manual steps during the lifecycle of your deployment, then you
+should consider creating a custom strategy. See the section below on custom


can we add link to that section here?

mfojtik · 2016-09-23T10:14:46Z

dev_guide/deployments.adoc

@@ -99,46 +105,47 @@ spec:
 <4> An xref:image-change-trigger[image change trigger] trigger causes a new replication controller to be
 created each time a new version of the `origin-ruby-sample:latest` image stream tag is available.
 <5> The xref:rolling-strategy[Rolling strategy] is the default way of deploying your pods. May be omitted.
-<6> The existing running deployment will not be paused. Pod template or image changes cover the full spectrum of changes on which deployments currently run.
-<7> Revision history limit is the limit of old replication controllers you want to keep around for rolling back. May be omitted. If omitted, old replication controllers will not be cleaned.
+<6> Pause a deployment configuration. This allows for multiple changes on the pod template before actually rolling it out.


maybe describe that this will mute the ConfigChange trigger and ImageChange trigger?

mfojtik · 2016-09-23T10:15:56Z

dev_guide/deployments.adoc


 ----
 $ oc deploy --latest dc/<name>
 ----

 [NOTE]
 ====
-If a deployment is already in progress, the command will display a
+If a deployment process is already in progress, the command will display a


maybe mention --cancel here?

We already display the suggestion when somebody hits this.

mfojtik · 2016-09-23T10:19:46Z

dev_guide/deployments.adoc

 ====

 [[retrying-a-deployment]]

 == Retrying a Deployment

-To retry the last failed deployment:
+If the current revision of your deployment configuration failed to deploy, you can


maybe worth to describe how to debug failures? (maybe worth to add a section dedicated for that)

I will open a follow-up issue since this is out of scope for this PR.

i'm ok with follow up

mfojtik · 2016-09-23T10:22:38Z

dev_guide/deployments.adoc

 ====

+[[deployment-triggers-using-the-command-line]]


reminder for future me: describe the oc set image here (it will trigger deployment and maybe used to manually controller what image will be deployed)

I don't think we want to intermingle set image with triggers. This will push users to use set image which is 1) not needed and 2) will get us into pretty weird states if we bypass triggers.

At the very least we need to identify why would somebody use set image while using a trigger and need to sort out if we can fix any weirdness that comes along with bypassing triggers.

mfojtik · 2016-09-23T10:31:22Z

dev_guide/deployments.adoc

+=== When to use a recreate deployment?
+
+* When you must run migrations or other data transformations before your new code starts
+* When you don't support having new and old versions of your application code running at the same time


maybe add the RWO volume here?

mfojtik · 2016-09-23T10:32:15Z

dev_guide/deployments.adoc

+
+=== Blue-Green Deployment
+
+Blue-Green deployments involve running two versions of an application at the same time and moving production traffic from the old version to the new version ([more about blue-green deployments](http://martinfowler.com/bliki/BlueGreenDeployment.html)). There are several ways to implement a blue-green deployment in {product-title}.


point to example below?

We don't point from the description of the strategy to its example in any of the other descriptions and I don't think we need to (you just need to scroll down and finish reading about the strategy you are reading:))

mfojtik · 2016-09-23T10:32:27Z

dev_guide/deployments.adoc

+Blue-Green deployments involve running two versions of an application at the same time and moving production traffic from the old version to the new version ([more about blue-green deployments](http://martinfowler.com/bliki/BlueGreenDeployment.html)). There are several ways to implement a blue-green deployment in {product-title}.
+
+
+=== When to use a blue-green deployment?


Blue-Green for consistency

mfojtik · 2016-09-23T10:34:51Z

dev_guide/deployments.adoc

+1. Create two copies of the example application
+
+---
+$ oc new-app openshift/deployment-example:v1 --name=bluegreen-example-old


maybe the name should be example-blue and example-green ? ;-)

mfojtik · 2016-09-23T10:35:13Z

dev_guide/deployments.adoc

+$ oc edit route/bluegreen-example
+---
+
+Change `spec.to.name` to `bluegreen-example-new` and save and exit the editor.


can you provide a patch command for this?

mfojtik · 2016-09-26T11:40:02Z

LGTM @openshift/team-documentation ship it :-)

0xmichalis · 2016-10-04T09:13:26Z

@adellape ping

0xmichalis · 2016-10-06T13:51:50Z

@mfojtik re https://trello.com/c/oAlPryPh/793-3-need-to-document-how-to-use-upstream-deployments I guess we want a section in our docs that compares DCs vs D, is that right? Would you say that this PR blocks the Trello card?

mfojtik · 2016-10-06T14:10:55Z

@Kargakis it does not, the trello card is about documenting the upstream deployments and comparing them with Origin deployments.

0xmichalis · 2016-10-10T10:19:19Z

@adellape ping

0xmichalis · 2016-10-19T16:18:28Z

@adellape note that all these changes are effective in 3.3 - not sure why this has the 3.4 flag

0xmichalis · 2016-10-19T16:18:49Z

@vikram-redhat ^

0xmichalis · 2016-10-19T16:19:36Z

I would like to move forward with this so I can lay on top some minor changes for 3.4. Thanks.

vikram-redhat · 2016-10-24T10:40:47Z

@ahardin-rh - PTAL.

bfallonf · 2016-10-25T01:04:42Z

@adellape @ahardin-rh Might be worth looking at this issue and putting in that info in the followup (or in a separate followup):

#2930

0xmichalis · 2016-11-02T11:51:27Z

@ahardin-rh can you have a look?

ahardin-rh · 2016-11-02T17:20:10Z

continuing work in #3149

mfojtik suggested changes Sep 23, 2016

View reviewed changes

0xmichalis mentioned this pull request Sep 23, 2016

post-deployment hook not finishing openshift/origin#11069

Closed

adellape self-assigned this Sep 30, 2016

Refine deployment docs, add advanced strategies

5684477

vikram-redhat added the branch/enterprise-3.4 label Oct 12, 2016

vikram-redhat added this to the Future Release milestone Oct 12, 2016

vikram-redhat added the branch/dedicated label Oct 12, 2016

vikram-redhat added branch/enterprise-3.3 branch/dedicated-3.3 and removed branch/dedicated branch/enterprise-3.4 labels Oct 24, 2016

vikram-redhat modified the milestones: Next Release, Future Release Oct 24, 2016

vikram-redhat added the branch/online label Oct 24, 2016

bfallonf mentioned this pull request Oct 25, 2016

Add a "Debugging" section in deployment doc #2930

Closed

ahardin-rh assigned ahardin-rh and unassigned adellape Nov 2, 2016

ahardin-rh mentioned this pull request Nov 2, 2016

Refine deployment docs, add advanced strategies #3149

Merged

ahardin-rh removed the branch/dedicated-3.3 label Nov 2, 2016

ahardin-rh removed branch/enterprise-3.3 branch/online labels Nov 2, 2016

ahardin-rh removed this from the Next Release milestone Nov 2, 2016

ahardin-rh closed this Nov 2, 2016

0xmichalis deleted the deployment-docs branch November 2, 2016 17:26


		=== Blue-Green Deployment

		Blue-Green deployments involve running two versions of an application at the same time and moving production traffic from the old version to the new version ([more about blue-green deployments](http://martinfowler.com/bliki/BlueGreenDeployment.html)). There are several ways to implement a blue-green deployment in {product-title}.

		Blue-Green deployments involve running two versions of an application at the same time and moving production traffic from the old version to the new version ([more about blue-green deployments](http://martinfowler.com/bliki/BlueGreenDeployment.html)). There are several ways to implement a blue-green deployment in {product-title}.


		=== When to use a blue-green deployment?

		====

		[[deployment-triggers-using-the-command-line]]

Refine deployment docs, add advanced strategies #2890

Refine deployment docs, add advanced strategies #2890

Conversation

0xmichalis commented Sep 22, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mfojtik commented Sep 26, 2016

0xmichalis commented Oct 4, 2016

0xmichalis commented Oct 6, 2016

mfojtik commented Oct 6, 2016

0xmichalis commented Oct 10, 2016

0xmichalis commented Oct 19, 2016

0xmichalis commented Oct 19, 2016

0xmichalis commented Oct 19, 2016

vikram-redhat commented Oct 24, 2016

bfallonf commented Oct 25, 2016

0xmichalis commented Nov 2, 2016

ahardin-rh commented Nov 2, 2016 • edited Loading

ahardin-rh commented Nov 2, 2016 •

edited

Loading