Skip to content

6.configuration.md: fix scope in example #127

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

Closed
hongchaodeng wants to merge 2 commits into from
Closed

6.configuration.md: fix scope in example #127

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67c745e
6.configuration.md: fix scope in example
hongchaodeng Sep 6, 2019
49b9c2c
minor
hongchaodeng Sep 13, 2019
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
15 changes: 10 additions & 5 deletions 6.operational_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ This section defines the instances of components to create with this operational
| `instanceName` | `string` | Y | | The name of the instance of this component. |
| `parameterValues` | [`[]ParameterValue`](#parameterValue) | N | | Overrides of parameters that are exposed by the application scope type defined in `type`. |
| `traits` | [`[]Trait`](#trait) | N | | Specifies the traits to attach to this component instance. |
| `applicationScopes` | [`[]string`] | N | | Specifies the application scopes to attach to this component instance. Each item is a name referenced to the defined Scopes in this configuration. |

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

Expand Down Expand Up @@ -163,12 +164,14 @@ spec:
variables:
- name: VAR_NAME
value: SUPPLIED_VALUE
- name: networkName
value: ""
scopes:
- name: core.hydra.io/v1alpha1.Network
parameterValues:
- name: PARAM_NAME
value: SUPPLIED_VALUE
fromParam: NAME_OF_TOP_LEVEL_PARAM
- name: myNetworkScope
type: core.hydra.io/v1alpha1.Network
properties:
Copy link
Contributor

@mikkelhegn mikkelhegn Sep 6, 2019

Choose a reason for hiding this comment

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

I suggest the example property be something different, to show it's configuring the application scope (all depending on the applicationScope capabilities)

I know this https://github.com/microsoft/hydra-spec/blob/master/4.application_scopes.md#network-scope is mentioning a networkName, but that's a bit weird as we now have a name as part of the spec and a parameter, so we should og back and get the core network scope fixed as well (will raise an issue)

properties:
   - name: ingressVisibility
     value: true
   - name: subnetName
     value: "[fromVariable(subnet-name)]"

Copy link
Contributor

@mikkelhegn mikkelhegn Sep 6, 2019

Choose a reason for hiding this comment

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

https://github.com/microsoft/hydra-spec/issues/129

Copy link
Contributor

@mikkelhegn mikkelhegn Sep 13, 2019

Choose a reason for hiding this comment

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

Will be fixed by #140

- name: networkName
value: "[fromVariable(networkName)]"`
components:
- componentName: my-web-app-component
instanceName: my-app-frontent
Expand All @@ -183,6 +186,8 @@ spec:
properties:
CUSTOM_OBJECT:
DATA: "[fromVariable(VAR_NAME)]"
applicationScopes:
- myNetworkScope
Copy link
Contributor

@mikkelhegn mikkelhegn Sep 6, 2019

Choose a reason for hiding this comment

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

It's yet to be defined how this should look: https://github.com/microsoft/hydra-spec/blob/master/6.operational_configuration.md#component - I've seen both just a name reference, but also a type. I suggest we assume this will be similar to Traits: https://github.com/microsoft/hydra-spec/blob/master/6.operational_configuration.md#trait

      applicationScopes: 
        - name: testNetworkScope2
          type: core.hydra.io/v1alpha1.Network

issue: https://github.com/microsoft/hydra-spec/issues/130 to specifically track this.

Copy link
Member

@wonderflow wonderflow Sep 16, 2019

Choose a reason for hiding this comment

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

I think a name with a type is OK, though it's even impossible for two app scopes to use same name in real user cases


```

Expand Down