Skip to content

Bug 1384018: New "Kubernetes Deployments Support" topic #3255

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

Merged
merged 1 commit into from
Nov 21, 2016

Conversation

adellape
Copy link
Contributor

@adellape adellape commented Nov 18, 2016

@adellape adellape added this to the Future Release milestone Nov 18, 2016
@adellape adellape changed the title New "Kubernetes Deployments Support" topic Bug 1384018: New "Kubernetes Deployments Support" topic Nov 18, 2016
@adellape adellape force-pushed the kubernetes-deployments branch from 0c90110 to 913ebd6 Compare November 18, 2016 21:19
@adellape
Copy link
Contributor Author

@ahardin-rh PTAL 🙇‍♀️


- xref:../../dev_guide/managing_images.adoc#dev-guide-managing-images[image streams]
- xref:../../dev_guide/deployments/deployment_strategies.html#lifecycle-hooks[lifecycle hooks]
- xref:../../dev_guide/deployments/deployment_strategies.html#custom-strategy[Custom deployment strategies]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Custom is capitalized here, but "image" and lifestyle" are not.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I capitalized it since we capitalize it in the doc it links to, as the type of strategy. I could go either way here.

$ oc rollout pause deployments/<name>
----

At the moment, upstream Deployment do not support ImageChange triggers. A generic triggering
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/Deployment/deployments

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops I missed this paragraph completely.

----

At the moment, upstream Deployment do not support ImageChange triggers. A generic triggering
mechanism has been proposed upstream but it is unknown if and when will it be accepted.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

upstream, but

----

At the moment, upstream Deployment do not support ImageChange triggers. A generic triggering
mechanism has been proposed upstream but it is unknown if and when will it be accepted.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/will it/it will


At the moment, upstream Deployment do not support ImageChange triggers. A generic triggering
mechanism has been proposed upstream but it is unknown if and when will it be accepted.
Eventually, we can implement our own mechanism on top but it would be more desirable for it
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe reword this sentence to focus on "you" instead of "we". Also, the "on top" is confusing. Perhaps reword to:

Eventually, you will be able to implement your own mechanism. However, it is more desirable to have this exist as part of the Kubernetes core.

[[dc-vs-d-custom-strategies]]
==== Custom Strategies

Kubernetes deployments do not yet support user-specified Custom deployment
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/Custom/custom

@ahardin-rh
Copy link
Contributor

@adellape Just a few comments from me. Looks good overall!

@adellape adellape force-pushed the kubernetes-deployments branch 3 times, most recently from 19a9038 to fc0547e Compare November 18, 2016 22:18
@adellape
Copy link
Contributor Author

@ahardin-rh Thanks, edits made.

@Kargakis @mfojtik PTAL. Preview:

http://file.rdu.redhat.com/~adellape/111816/kubernetes-deployments/dev_guide/deployments/kubernetes_deployments.html

Some notes on my thinking here:

  • Went with calling the object "Kubernetes deployments" to differentiate it from deployment configurations, but without simply calling it "deployments". Also prefered it over "upstream deployments". At some point in the future after deployments evolves further (and it comes out of Tech Preview), I figure we can at that point do the work to unify on deployments throughout the docs over deploymentConfigs, and call them simply "deployments".
  • Named the topic "Kubernetes Deployments Support" instead of simply "Kubernetes Deployments" since the content seemed to mostly talk about the state of deployments vs deploymentConfigs (e.g., discussing the inside baseball of Kube and OpenShift development goals), rather than actual usage (which the linked-to Kubernetes documentation goes into further).

@adellape adellape force-pushed the kubernetes-deployments branch from fc0547e to 386ebbc Compare November 18, 2016 22:27
@@ -107,6 +107,7 @@ syntax:
|`build` |
|`buildConfig` | `bc`
|`deploymentConfig` | `dc`
|`deployments` (Technology Preview)|
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Kargakis Correct that there's no abbreviation for this?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In 3.3 there is none, in 3.4 there is deploy.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK thanks, since this PR is for 3.4, I'll add deploy as the abbreviation here.

@@ -117,6 +118,7 @@ syntax:
|`pod` |`po`
|`ResourceQuota` | `quota`
|`replicationController` |`rc`
|`replicaSet` (Technology Preview)|`rs`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Kargakis Correct to say that replica sets are also Tech Preview, if deployments are?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure about that, @smarterclayton ?

Copy link
Contributor Author

@adellape adellape Nov 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see replica sets listed as Tech Preview in Origin 1.3 here:

https://github.com/openshift/origin#alpha-and-unsupported-kubernetes-features

image: nginx:1.7.9
ports:
- containerPort: 80
----
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Kargakis This example is from the Kube deployments doc. Is there another one you'd suggest using instead?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it's fine. I would change the name from "nginx-deployment" to "nginx".

@0xmichalis
Copy link

LGTM

@adellape adellape force-pushed the kubernetes-deployments branch from 386ebbc to 1c2f0a4 Compare November 21, 2016 19:03
@adellape
Copy link
Contributor Author

Latest edits made and QE sign-off in BZ. Merging.

@adellape adellape merged commit 5808a32 into openshift:master Nov 21, 2016
@adellape
Copy link
Contributor Author

[rev_history]
|xref:../dev_guide/deployments/kubernetes_deployments.adoc#dev-guide-kubernetes-deployments-support[Deployments -> Kubernetes Deployments Support]
|New topic detailing Technology Preview support for the new Kubernetes-provided deployments object type.
%

@0xmichalis
Copy link

Thanks!

@vikram-redhat vikram-redhat modified the milestones: Future Release, Staging, OCP 3.4 GA Jan 16, 2017
@adellape adellape modified the milestones: OCP 3.4 GA, Staging, Temp Feb 1, 2017
@adellape adellape deleted the kubernetes-deployments branch November 9, 2017 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants