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.

Sign up for GitHub

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

Jump to bottom

add openshift labels for app deployment #69

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

add openshift labels for app deployment #69

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5629fef
add openshift labels for app deployment
aweiteka Apr 21, 2016
0db2c0e
Use config.env for parameterization config
aweiteka May 2, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The following types of data are being considered:
| stop | Command to execute before stopping container|
| debug | Command to run the image with debugging turned on|

2. Labels Names used to describe the application/image
1. Labels Names used to describe the application/image

| Name | Description |
|-------------|----------------------------------------|
Expand All @@ -45,8 +45,9 @@ The following types of data are being considered:
| authoritative-source-url | The authoritative location in which the image is published|
| distribution-scope | Intended scope of distribution for image (see below for possible values)|
| changelog-url | URL of a page containing release notes for the image|
| config | A namespace for defining the application configuration (see below for possible values)|

3. Possible values of distribution-scope field
1. Possible values of distribution-scope field

|Name | Description |
|-------------|-------------|
Expand All @@ -55,11 +56,25 @@ The following types of data are being considered:
| restricted | Redistribution only with permission|
| public | No redistribution limits beyond licenses|

4. Custom labels may be defined by a namespace prefix using reverse DNS notation of a domain controlled by the author. For example, `com.redhat.access`.
1. Possible values of config field. Application configuration may be defined or hinted using the config label. This allows documentation and tooling to provide parameterization control. Currently, environment variables are the only parameter, with three attributes.

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

@bparees bparees May 2, 2016 •
edited
Loading

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)

| config.env.KEY.description | Description|
| config.env.KEY.required | Required boolean, true or false.|
Example:

LABEL config.env.foo=bar \
config.env.foo.description="Lorem ipsum dolor sit amet" \
config.env.foo.required=true

1. Custom labels may be defined by a namespace prefix using reverse DNS notation of a domain controlled by the author. For example, `com.redhat.access`.

LABEL io.openshift.expose-services="8080:http" \
io.openshift.tags="builder,nodejs,nodejs010"


## Details on Labels

## `authoritative-source-url`
Expand Down