Skip to content
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

add openshift labels for app deployment #69

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

aweiteka
Copy link
Collaborator

No description provided.

@aweiteka
Copy link
Collaborator Author

cc @bparees @brianwcook

@aweiteka
Copy link
Collaborator Author

@bparees I didn't see docs on mid hooks. Do I have the right hook type in mind?

@@ -45,6 +45,10 @@ $authoritative-source[:PORT]/PRODUCT[$PRODUCTGEN][--$PLATFORMDIFFERENTIATOR]/REP
| io.k8s.display-name | no | Name of the container displayed in Kubernetes |
| io.openshift.expose-services | no | port:service pairs separated with comma, e.g. `"8080:http,8443:https"` |
| io.openshift.tags | no | tags used by searching engine, e.g. `"builder,php,php56,rh-php56"` |
| io.openshift.env-KEY | no | Required environment variable. Creates parameter named "KEY". If no value is provided user input required. |
| io.openshift.podhook.pre | no | Pre exec pod-based lifecycle hook command. See [documentation](https://docs.openshift.org/latest/dev_guide/deployments.html#pod-based-lifecycle-hook) |
| io.openshift.podhook.post | no | Post exec pod-based lifecycle hook command. See [documentation](https://docs.openshift.org/latest/dev_guide/deployments.html#pod-based-lifecycle-hook) |
Copy link

Choose a reason for hiding this comment

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

it's a deployment hook, not a pod hook. the "pod-based" part refers to the fact that the logic is executed in a pod.

@bparees
Copy link

bparees commented Apr 21, 2016

@aweiteka might be missing doc. @ironcladlou do we not have doc for mid-hooks?

@bparees
Copy link

bparees commented Apr 21, 2016

we probably need to see an example of how those labels will actually look with values. Presumably it's going to be a giant blob of json (that defines a hook), which seems unfriendly but is going to be the most flexible option....

@ironcladlou
Copy link

There's a documentation gap around mid hooks. They're supported only by the Recreate strategy. The docs for mid will should look the same as for pre and post: https://docs.openshift.org/latest/dev_guide/deployments.html#recreate-strategy

@aweiteka
Copy link
Collaborator Author

Mid hooks docs issue pointing to implementation PR: openshift/openshift-docs#1779

@aweiteka
Copy link
Collaborator Author

We could add cmd and args labels but relying on the Dockerfile for those is probably less confusing.

@aweiteka aweiteka force-pushed the ose-labels branch 5 times, most recently from ceeb63f to 84a6933 Compare May 2, 2016 18:08
@aweiteka
Copy link
Collaborator Author

aweiteka commented May 2, 2016

@brianwcook updated.


|Name | Description |
|-------------|-------------|
| config.env.KEY | Default value. Use empty string "" if no default.|
Copy link

@bparees bparees May 2, 2016

Choose a reason for hiding this comment

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

i think we were doing to skip having a "default" value label and just try to pick up the default from any ENV statement in the dockerfile. But after we got off the phone, i had second thoughts and i think we still want to have an (optional) default label, but the name should be:
config.env.KEY.default

we were also going to add another optional label:
config.env.KEY.displayName

which is a value used to label the input field for the value in UIs. (if not provided, the label for the field will just KEY)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants