TemplateConfig implementation with Kubernetes #41

mfojtik · 2014-09-02T13:51:19Z

Initial implementation of TemplateConfig REST endpoint.

See the project.json example.

To test this PR:

$ curl -d @pkg/template/examples/project.json \
  http://localhost:8080/api/v1beta1/templateConfigs

This will return Config{} which is essentially the same as a templateConfig{} but without parameters.

FYI: This is a wip, all commits will be squashed in the end. @VojtechVitek is working on validation atm. so I don't want to force push ;-)

bparees · 2014-09-02T14:02:48Z

@mfojtik why are we back to having replicationControllers and not DeploymentConfig objects in this spec?

mfojtik · 2014-09-02T14:04:06Z

@bparees deploymentConfig is not yet merged, so I can't use them atm. I made a TODO in this PR to replace replicationController once it will be there.

Also the k8s Config{} right now does not define deploymentConfig.

mfojtik · 2014-09-02T14:14:31Z

@bparees actually I'm taking the last comment back ;-) The replicationController should stay here, the deploymentConfig and buildConfig will be added to the list once they will become available.

mfojtik · 2014-09-02T15:33:04Z

pkg/cmd/master/master.go

@@ -100,7 +101,8 @@ func startAllInOne() {

 	// initialize OpenShift API
 	storage := map[string]apiserver.RESTStorage{
-		"services": service.NewRESTStorage(service.MakeMemoryRegistry()),
+		"services":        service.NewRESTStorage(service.MakeMemoryRegistry()),
+		"templateConfigs": template.NewRegistryStorage(),


@VojtechVitek maybe rename this to NewRESTStorage ?

bparees · 2014-09-02T20:58:38Z

pkg/template/template.go

+}
+
+// ProcessParameters searches the ReplicationControllers and Pods defined in the
+// TemplateConfig and substitutes the references to parameters with the parameter


Are we assuming services won't have substitutable content?

It's a fair point. I can imagine service having randomized port number.

well, if you think about this more, we can also do substitutions in properties like 'name' or 'description', maybe even in 'label'. I can think of scenario when you have development and production template and you want to change the environment (even the name of services) based on the parameter value.

@smarterclayton does it make sense?

Make sense to me. One templateConfig should be able to create several (dev, prod, qa etc.) resources that differ just in one label.

@mfojtik how would we propagate such different value to parameter generator? I mean, I have a template config file with ${environment} parameter that defaults to prod and I want to change it to dev during the POST /templateConfigs. Does it make sense?

@VojtechVitek I think you'd have to specify the value when defining the parameter at the top of the file (ie in the parameters section). I suppose we could also enable the /templateConfigs endpoint to accept arguments that overrode/explicitly set parameter values.

@bparees we can do that by using the custom parameters we already support. I just need to figure out how to pass a map of parameters to the Create method ;-)

@VojtechVitek there are two options. First is what @bparees described and the second is that you will have 2 different templates (one for prod and one for dev)

It would be pretty easy for a client submitting a template to change the values. Worth discussion.

@smarterclayton you mean the actual client implementation would swap out values (based on some flags passed to the client invocation) in the json before invoking the rest endpoint? Sounds reasonable...

Yeah - cause at least a Go client will have a TemplateConfig object, so for them they can just say "read template config from disk, override parameter X".

This is a good pattern in general in Kubernetes - making the API objects composable so that your client code on both the server or in a CLI can do the same thing the same way.

VojtechVitek · 2014-09-02T21:24:41Z

How to build/run:

cd $GOPATH/src/github.com/openshift/origin
./hack/build-go.sh
./output/go/bin/openshift start

How to test (in different terminal window):

cd $GOPATH/src/github.com/openshift/origin
curl -d @examples/guestbook/template.json http://localhost:8080/osapi/v1beta1/templateConfigs

smarterclayton · 2014-09-03T16:32:29Z

pkg/cmd/master/master.go

@@ -100,7 +101,8 @@ func startAllInOne() {

 	// initialize OpenShift API
 	storage := map[string]apiserver.RESTStorage{
-		"services": service.NewRESTStorage(service.MakeMemoryRegistry()),
+		"services":        service.NewRESTStorage(service.MakeMemoryRegistry()),
+		"templateConfigs": template.NewRESTStorage(),


Change the name here to be NewStorage() - the other ones will be removed.

smarterclayton · 2014-09-09T04:40:11Z

pkg/template/api/validation/validation.go

+		default:
+			err = append(err, NewFieldInvalid("kind", fmt.Sprintf("%T", item)))
+		}
+		errs = append(errs, err.Prefix(fmt.Sprintf("items[%d]", i))...)


err.PrefixIndex(i).Prefix("items")

mfojtik · 2014-09-09T10:48:34Z

@smarterclayton I think we are ready for the final round :-)

smarterclayton · 2014-09-09T14:23:23Z

Can you guys open a follow up pull to do the following:

example readme that describes how to use this
openshift cli support (not kubecfg) for turning a template into a config and then creating the config (the config part should be near identical to the pull you did for Kube)
an integration test that mutates a template into config by POSTing to /templateConfigs and then uses the client config code to create the objects, then test that the objects were correctly created

mfojtik · 2014-09-09T14:25:41Z

@smarterclayton sure thing... the object creation integration test will require Config PR.

smarterclayton · 2014-09-09T15:39:47Z

Let me know when this is ready for final review.

smarterclayton · 2014-09-09T15:45:59Z

pkg/template/api/validation/validation_test.go

+	shouldPass := func(template *api.Template) {
+		errs := ValidateTemplate(template)
+		if len(errs) != 0 {
+			_, _, line, _ := goruntime.Caller(1)


This is probably not the right way to do this, I understand why you added it though. Generally you would write this as a table test instead. In your follow up can you refactor this to make a table test?

Sure, I'll do the refactoring in the follow up.

mfojtik · 2014-09-09T15:52:10Z

LGTM

Adds TemplateProcessor implementation using the default ExpressionValueGenerator, which is capable of transforming Template api objects into Config api objects. Authors: Michal Fojtik <mfojtik@redhat.com> Vojtech Vitek <vvitek@redhat.com>

smarterclayton · 2014-09-09T16:18:01Z

LGTM [merge]

openshift-bot · 2014-09-09T16:19:07Z

Evaluated for origin up to 1ba20a8

openshift-bot · 2014-09-09T17:12:06Z

Origin Merge Results: SUCCESS (https://ci.openshift.redhat.com/jenkins/job/merge_pull_requests_openshift3/74/) (Image: devenv-fedora_140)

Merged by openshift-bot

Fix UI e2e test failure

return if error is a stop by user event

grpc

…enshift#41)

mfojtik reviewed Sep 2, 2014
View reviewed changes

VojtechVitek force-pushed the templateConfig branch from c403459 to 8853d77 Compare September 2, 2014 19:13

bparees reviewed Sep 2, 2014
View reviewed changes

VojtechVitek force-pushed the templateConfig branch 2 times, most recently from ca6c1d3 to a52edc8 Compare September 2, 2014 22:07

smarterclayton changed the title ~~[WIP][POC] TemplateConfig implementation with Kubernetes~~ [WIP] TemplateConfig implementation with Kubernetes Sep 3, 2014

mfojtik changed the title ~~[WIP] TemplateConfig implementation with Kubernetes~~ TemplateConfig implementation with Kubernetes Sep 3, 2014

smarterclayton self-assigned this Sep 3, 2014

smarterclayton reviewed Sep 3, 2014
View reviewed changes

smarterclayton reviewed Sep 9, 2014
View reviewed changes

mfojtik force-pushed the templateConfig branch 2 times, most recently from d587206 to cf08db6 Compare September 9, 2014 10:48

VojtechVitek force-pushed the templateConfig branch 4 times, most recently from 95f20ca to 0671283 Compare September 9, 2014 15:33

smarterclayton reviewed Sep 9, 2014
View reviewed changes

VojtechVitek force-pushed the templateConfig branch from 0671283 to e7c775d Compare September 9, 2014 15:48

Implement TemplateConfig endpoint

1ba20a8

Adds TemplateProcessor implementation using the default ExpressionValueGenerator, which is capable of transforming Template api objects into Config api objects. Authors: Michal Fojtik <mfojtik@redhat.com> Vojtech Vitek <vvitek@redhat.com>

VojtechVitek force-pushed the templateConfig branch from e7c775d to 1ba20a8 Compare September 9, 2014 16:03

openshift-bot pushed a commit that referenced this pull request Sep 9, 2014

Merge pull request #41 from mfojtik/templateConfig

af59397

Merged by openshift-bot

openshift-bot merged commit af59397 into openshift:master Sep 9, 2014

spadgett pushed a commit to spadgett/origin that referenced this pull request Apr 11, 2016

Merge pull request openshift#41 from spadgett/fix-ui-e2e-tests

bbd0039

Fix UI e2e test failure

danwinship pushed a commit to danwinship/origin that referenced this pull request Jun 24, 2016

Merge pull request openshift#41 from rajatchopra/master

b0ebf57

return if error is a stop by user event

ncdc pushed a commit to ncdc/origin that referenced this pull request Mar 22, 2017

Merge pull request openshift#41 from ncdc/rebase-1.6.0-beta3

477a5d7

grpc

jpeeler pushed a commit to jpeeler/origin that referenced this pull request Feb 1, 2018

Refactor status for API resources to conditions instead of states (op…

88d4aed

…enshift#41)

mfojtik deleted the templateConfig branch September 5, 2018 21:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TemplateConfig implementation with Kubernetes #41

TemplateConfig implementation with Kubernetes #41

mfojtik commented Sep 2, 2014

bparees commented Sep 2, 2014

mfojtik commented Sep 2, 2014

mfojtik commented Sep 2, 2014

mfojtik Sep 2, 2014

bparees Sep 2, 2014

VojtechVitek Sep 2, 2014

mfojtik Sep 3, 2014

VojtechVitek Sep 3, 2014

bparees Sep 3, 2014

mfojtik Sep 3, 2014

mfojtik Sep 3, 2014

smarterclayton Sep 3, 2014

bparees Sep 3, 2014

smarterclayton Sep 3, 2014

VojtechVitek commented Sep 2, 2014

smarterclayton Sep 3, 2014

smarterclayton Sep 9, 2014

mfojtik commented Sep 9, 2014

smarterclayton commented Sep 9, 2014

mfojtik commented Sep 9, 2014

smarterclayton commented Sep 9, 2014

smarterclayton Sep 9, 2014

VojtechVitek Sep 9, 2014

mfojtik commented Sep 9, 2014

smarterclayton commented Sep 9, 2014

openshift-bot commented Sep 9, 2014

openshift-bot commented Sep 9, 2014

TemplateConfig implementation with Kubernetes #41

TemplateConfig implementation with Kubernetes #41

Conversation

mfojtik commented Sep 2, 2014

bparees commented Sep 2, 2014

mfojtik commented Sep 2, 2014

mfojtik commented Sep 2, 2014

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

VojtechVitek commented Sep 2, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mfojtik commented Sep 9, 2014

smarterclayton commented Sep 9, 2014

mfojtik commented Sep 9, 2014

smarterclayton commented Sep 9, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mfojtik commented Sep 9, 2014

smarterclayton commented Sep 9, 2014

openshift-bot commented Sep 9, 2014

openshift-bot commented Sep 9, 2014