Skip to content

Commit

Permalink
address for comments
Browse files Browse the repository at this point in the history
  • Loading branch information
wonderflow committed May 14, 2020
1 parent 76526dc commit ceb6847
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions 7.application_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,12 @@ This section defines the instances of components to create with the application

| Attribute | Type | Required | Default Value | Description |
|-----------|------|----------|---------------|-------------|
| `componentName` | `string` | N | | The name of the component of which to bind application configuration. Using componentName represent the ApplicationConfiguration always track the latest revision. |
| `revisionName` | `string` | N | | The name of the component revision of which to bind application configuration. |
| `componentName` | `string` | N | | The name of the component whose latest revision will be bind with application configuration. When the spec of the referenced component changes, ApplicationConfiguration will automatically migrate all trait affect from the prior revision to the new one. This is mutually exclusive with revisionName.|
| `revisionName` | `string` | N | | RevisionName of a specific component revision to which to bind application configuration. This is mutually exclusive with componentName. |
| `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.

* 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

0 comments on commit ceb6847

Please sign in to comment.