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

make component muteable and add revisionName #356

Merged
merged 4 commits into from
May 15, 2020
Merged

make component muteable and add revisionName #356

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
76526dc
make component muteable and add revisionName
wonderflow May 12, 2020
ceb6847
address for comments
wonderflow May 13, 2020
7f74777
Update 7.application_configuration.md
wonderflow May 15, 2020
62177c5
Update 7.application_configuration.md
wonderflow May 15, 2020
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
8 changes: 7 additions & 1 deletion 7.application_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,17 @@ This section defines the instances of components to create with the application

| Attribute | Type | Required | Default Value | Description |
|-----------|------|----------|---------------|-------------|
| `componentName` | `string` | Y | | The name of the component of which to create an instance. |
| `componentName` | `string` | N | | The name of the component of which to bind application configuration. Using componentName represent the ApplicationConfiguration always track the latest revision. |
wonderflow marked this conversation as resolved.
Show resolved Hide resolved
| `revisionName` | `string` | N | | The name of the component revision of which to bind application configuration. |
| `parameterValues` | [`[]ParameterValue`](#parameterValue) | N | | Overrides of parameters that are exposed by the application scope type defined in `type`. |
| `scopes` | [`[]Scope`](#scope) | N | | The scopes to be used in the component. A component joins a scope by referencing it. |
| `traits` | [`[]Trait`](#trait) | N | | The traits to attach to this component instance. |

One of `componentName` and `revisionName` is required. Everytime when a component is changed, a component revision will auto-generated by OAM implementation and can be viewed by user.
wonderflow marked this conversation as resolved.
Show resolved Hide resolved

* Using `componentName` here means the ApplicationConfiguration will always track the latest verison of the component.
* Using `revisionName` means only the specific revision of component will work, newly changed component version can only work after the `revisionName` is match with the new name.

In addition to being unique, the `componentName` must follow these naming rules:

> The componentName field is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.
Expand Down