Add channels support to the Habitat type #128

nhlfr · 2017-11-10T15:12:51Z

Habitat applications can exist in the different "channels" -
like "staging", "production", "unstable" etc. Those names
can be configured by the user.

Those channels will be expressed as labels in Kubernetes.

There is also a possibiity of promoting Habitat applications.
This action is expressed by HabitatPromote object, which needs
to be created in order to perform it.

To test that functionality, you can use the example yml files:

kubectl create -f examples/standalone/habitat.yml
kubectl create -f examples/standalone/habitat-promote.yml

Fixes #126

Signed-off-by: Michal Rostecki michal@kinvolk.io

dongsupark

You probably would want to add a test for the channel in test/e2e/operator_test.go.

And although it comes from our discussion today, I would like to listen to what other people think in the next week.

dongsupark · 2017-11-10T15:51:53Z

pkg/habitat/apis/cr/v1/types.go

@@ -29,6 +29,10 @@ const (
 HabitatNameLabel = "habitat-name"

 TopologyLabel = "topology"
+
+ // HabitatChannelLabel contains the information about stability of application.
+ // Examole: 'channel: production'


NIT: s/Examole/Example/

lilic

I am not very familiar with the channels, is it possible to promote a running application to another channel, for example from unstable to stable?

Please add an example and some documentation about channels to the examples directory. Also please add this new field to the https://github.com/kinvolk/habitat-operator/blob/master/docs/api.md#habitatspec. Thanks!

lilic · 2017-11-13T08:21:33Z

pkg/habitat/controller/controller.go

- crv1.HabitatLabel: "true",
- crv1.HabitatNameLabel: h.Name,
- crv1.TopologyLabel: topology.String(),
+ crv1.HabitatLabel: "true",


I am a bit confused why choose labels, maybe I am missing some info? From what I can tell you can pass in the argument the same way we do for other options: --channel unstable?

I don't understand the question. I'm passing the label to the deployment just to store the info (from which channel comes the app).

What I meant, will these labels be only used for information purposes?

Well, the other purpose may be creating services for specific environments (to expose ports). When you have an application with one name, but with two channels (i.e. staging and production), you can create two services with selectors looking for different channels.

asymmetric · 2017-11-13T13:43:20Z

pkg/habitat/apis/cr/v1/types.go

@@ -44,6 +48,8 @@ type HabitatSpec struct {
 // Image is the Docker image of the Habitat Service.
 Image string `json:"image"`
 Service Service `json:"service"`
+ // Channel is the information about stability of the application, expressed as a label in Kubernetes.
+ Channel string `json:"channel"`


Is this a mandatory field? If not, please add optional to the comment.

Would it make sense to have a default value when the user doesn't provide one?

Habitats default seems to be unstable

asymmetric

One question related to the new field.

tashimi · 2017-11-13T16:43:11Z

All newly built packages are automatically put on unstable to indicate there is a new build. A user then must do a promotion command (e.g. hab pkg promote foo) to promote a package to a different channel.

You can attach a label to a group of services, Application.Environment, with the idea being you can use this as an organizational principle to do group promotion of various tiers of your application. This is a capability we haven't fully fleshed out/made available yet.

For now, you should have the ability to promote a package from unstable to foo to stable. All packages by default will have at least an unstable and stable channel. Additional channels are user defined and added, and there can be as many as you want to power the promotion experience you want.

We anticipate it would be very unlikely for most users to have Supervisors subscribed directly to unstable without any additional testing, unless they had a true wild west development environment with automated testing set up, from which they could promote to a more stable pre-prod environment, and then to production/stable.

nhlfr · 2017-12-01T15:02:29Z

PTALA

lilic · 2017-12-04T12:54:54Z

@nhlfr it seems your tests failed, I re-trigged the build. Will have a look once they pass. :)

asymmetric · 2017-12-04T15:40:25Z

README.md

@@ -61,6 +61,12 @@ To create an example service run:
 This will create a single-pod deployment of an `nginx` Habitat service.
 More examples are located in the [example directory](https://github.com/kinvolk/habitat-operator/tree/master/examples/).

+### Promoting an example


Why Promoting an example? I'd say "Promoting a Habitat/application"

asymmetric · 2017-12-04T15:43:05Z

README.md

@@ -61,6 +61,12 @@ To create an example service run:
 This will create a single-pod deployment of an `nginx` Habitat service.
 More examples are located in the [example directory](https://github.com/kinvolk/habitat-operator/tree/master/examples/).

+### Promoting an example
+
+By default, the example service from `examples/standalone/habitat.yml` uses the `staging` channel. To promote it to the `production` channel, use the following example:


I think in this section we should instead briefly explain what promotion is in Habitat (or maybe only link to their docs) and clearly explain how we handle that in the operator.

asymmetric · 2017-12-04T15:43:08Z

README.md

+
+By default, the example service from `examples/standalone/habitat.yml` uses the `staging` channel. To promote it to the `production` channel, use the following example:
+
+ kubectl create -f examples/standalone/habitat-promote.yml


I think this example should be under examples/promotion. There should be two files there, one to create an application, named habitat.yml, and one for the promotion, named promotion.yml.

But that specific file is able to promote only the standalone application, it cannot be used to any other example!

The examples/promotion directory would contain both the habitat app's manifest and the promotion manifest to promote that app. Or am I missing something?

asymmetric · 2017-12-04T18:32:42Z

docs/api.md

+| Field | Description | Scheme | Required |
+| ----- | ----------- | ------ | -------- |
+| habitatName | Name of the Habitat object to promote. | string | true |
+| oldChannel | Name of the old channel which the Habitat application is using. | string | true |


I suggest: "Name of the channel the Habitat application is on before the promotion."

asymmetric · 2017-12-04T18:36:09Z

docs/api.md

+| ----- | ----------- | ------ | -------- |
+| habitatName | Name of the Habitat object to promote. | string | true |
+| oldChannel | Name of the old channel which the Habitat application is using. | string | true |
+| newChannel | Name of the new channel which the Habitat application is going to use after promotion. | string | true |


I suggest: "Name of the channel the Habitat application is moved to as part of the promotion."

asymmetric · 2017-12-04T18:37:02Z

examples/standalone/habitat-promote.yml

@@ -0,0 +1,8 @@
+apiVersion: habitat.sh/v1
+kind: HabitatPromote


Shouldn't it be HabitatPromotion? Isn't that more correct for a type/kind, i.e. that it is a noun?

Habitat applications can exist in the different "channels" - like "staging", "production", "unstable" etc. Those names can be configured by the user. Those channels will be expressed as labels in Kubernetes. There is also a possibiity of promoting Habitat applications. This action is expressed by HabitatPromote object, which needs to be created in order to perform it. To test that functionality, you can use the example yml files: kubectl create -f examples/standalone/habitat.yml kubectl create -f examples/standalone/habitat-promotion.yml Fixes #126 Signed-off-by: Michal Rostecki <michal@kinvolk.io>

nhlfr · 2017-12-08T17:07:28Z

@asymmetric ptala

asymmetric · 2017-12-11T14:43:31Z

pkg/habitat/controller/controller.go

- if hc.habitatNeedsUpdate(oldHab, newHab) {
- hc.enqueue(newHab)
+ if hc.habitatIsPromotiond(oldHab, newHab) {
+ // Remove old deployment


You forgot the very important . at the end! ;)

asymmetric · 2017-12-11T14:45:10Z

pkg/habitat/controller/controller.go

+ level.Error(hc.logger).Log("msg", "Failed to delete deployment", "name", deploymentName)
+ return
+ }
+ level.Info(hc.logger).Log("msg", "created deployment", "name", deploymentName)


Is this the correct message? Should it mention promotion, as in "promoted deployment"?

asymmetric · 2017-12-11T14:48:00Z

pkg/habitat/controller/controller.go

@@ -845,6 +953,15 @@ func (hc *HabitatController) conform(key string) error {
 return nil
 }

+func (hc *HabitatController) habitatIsPromotiond(oldHabitat, newHabitat *crv1.Habitat) bool {


Typo, should be "HabitatIsPromoted", or "isHabitatPromoted".

asymmetric · 2017-12-11T14:49:48Z

pkg/habitat/controller/controller.go

-func (hc *HabitatController) worker() {
- for hc.processNextItem() {
+func (hc *HabitatController) habitatWorker() {
+ for hc.processNextHabitatItem() {


All these renames make me think we should split the promotion into its own controller. If this PR is urgent and blocking we can postpone the split, though.

asymmetric · 2017-12-11T14:51:40Z

Also, tests are failing.

nhlfr · 2017-12-12T11:26:30Z

Needs to be re-designed and re-implemented

nhlfr · 2017-12-12T11:27:02Z

I'm not deleting the branch just to keep the code visible

asymmetric · 2017-12-12T11:28:54Z

What's the discussion that led to this decision?

robertgzr · 2017-12-12T11:38:17Z

we talked about it offline but the basic outcome was that a promotion should just be another
kubectl apply -f manifest.yml

For that the channel probably has to be part of the object name:
hab pkg ident: origin/pkg/ver/release, in channel unstable
becomes
origin-pkg-ver-release-unstable object (no need for random strings)

We don't have to remove the old deployment since that can be easily scripted if labels are set properly...

nhlfr requested review from asymmetric, krnowak, robertgzr, lilic and dongsupark November 10, 2017 15:12

dongsupark reviewed Nov 10, 2017

View reviewed changes

lilic suggested changes Nov 13, 2017

View reviewed changes

asymmetric reviewed Nov 13, 2017

View reviewed changes

asymmetric suggested changes Nov 13, 2017

View reviewed changes

nhlfr force-pushed the nhlfr/channel branch from 259c83d to 2bf72c6 Compare November 13, 2017 14:55

nhlfr changed the title ~~Add channels support to the Habitat type~~ [WIP] Add channels support to the Habitat type Nov 13, 2017

nhlfr force-pushed the nhlfr/channel branch 5 times, most recently from 755b5d1 to 515d109 Compare November 16, 2017 16:51

robertgzr mentioned this pull request Nov 21, 2017

Planning for Habitat Builder Demo kinvolk-archives/habitat-builder-to-kubernetes#5

Closed

12 tasks

nhlfr force-pushed the nhlfr/channel branch 4 times, most recently from 83fedaf to 5256ef2 Compare December 1, 2017 15:01

nhlfr changed the title ~~[WIP] Add channels support to the Habitat type~~ Add channels support to the Habitat type Dec 1, 2017

nhlfr force-pushed the nhlfr/channel branch from 5256ef2 to c503da7 Compare December 4, 2017 10:01

asymmetric suggested changes Dec 4, 2017

View reviewed changes

nhlfr force-pushed the nhlfr/channel branch 3 times, most recently from 51298ff to 350122d Compare December 8, 2017 13:32

Michal Rostecki added 5 commits December 8, 2017 17:02

examples: Add promotion example for standalone app

7a6a877

examples: Add RBAC rule for HabitatPromote

89135a3

docs: Add information about HabitatPromote to API documentation

eca6aa7

README: Add information about promoting Habitat applications

11baa9b

nhlfr force-pushed the nhlfr/channel branch from 350122d to 11baa9b Compare December 8, 2017 17:07

asymmetric suggested changes Dec 11, 2017

View reviewed changes

nhlfr closed this Dec 12, 2017

krnowak mentioned this pull request Apr 27, 2018

add channel to supervisor #259

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add channels support to the Habitat type #128

Add channels support to the Habitat type #128

nhlfr commented Nov 10, 2017 •

edited

Loading

dongsupark left a comment

dongsupark Nov 10, 2017

lilic left a comment

lilic Nov 13, 2017

nhlfr Nov 13, 2017

lilic Nov 13, 2017

nhlfr Nov 13, 2017 •

edited

Loading

asymmetric Nov 13, 2017

robertgzr Nov 13, 2017

asymmetric left a comment

tashimi commented Nov 13, 2017 •

edited

Loading

nhlfr commented Dec 1, 2017

lilic commented Dec 4, 2017

asymmetric Dec 4, 2017

asymmetric Dec 4, 2017

asymmetric Dec 4, 2017

nhlfr Dec 5, 2017

asymmetric Dec 6, 2017

asymmetric Dec 4, 2017

asymmetric Dec 4, 2017

asymmetric Dec 4, 2017

nhlfr commented Dec 8, 2017

asymmetric Dec 11, 2017

asymmetric Dec 11, 2017

asymmetric Dec 11, 2017 •

edited

Loading

asymmetric Dec 11, 2017

asymmetric commented Dec 11, 2017

nhlfr commented Dec 12, 2017

nhlfr commented Dec 12, 2017

asymmetric commented Dec 12, 2017

robertgzr commented Dec 12, 2017


		By default, the example service from `examples/standalone/habitat.yml` uses the `staging` channel. To promote it to the `production` channel, use the following example:

		kubectl create -f examples/standalone/habitat-promote.yml

		@@ -0,0 +1,8 @@
		apiVersion: habitat.sh/v1
		kind: HabitatPromote

Add channels support to the Habitat type #128

Add channels support to the Habitat type #128

Conversation

nhlfr commented Nov 10, 2017 • edited Loading

dongsupark left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lilic left a 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

nhlfr Nov 13, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asymmetric left a comment

Choose a reason for hiding this comment

tashimi commented Nov 13, 2017 • edited Loading

nhlfr commented Dec 1, 2017

lilic commented Dec 4, 2017

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

nhlfr commented Dec 8, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asymmetric Dec 11, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

asymmetric commented Dec 11, 2017

nhlfr commented Dec 12, 2017

nhlfr commented Dec 12, 2017

asymmetric commented Dec 12, 2017

robertgzr commented Dec 12, 2017

nhlfr commented Nov 10, 2017 •

edited

Loading

nhlfr Nov 13, 2017 •

edited

Loading

tashimi commented Nov 13, 2017 •

edited

Loading

asymmetric Dec 11, 2017 •

edited

Loading