Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ classes:
parameters:
description: >-
Parameters element specifying the configurable parameters to use when installing, or updating, the application.
Defined as a map where each key is the user-defined parameter name (e.g. `mysqlDatabase:`, `greeting:`, `idpName:`, `myAppEndpoint:`),
and value would be Parameter object, i.e. map[string]Parameter.
See the [Parameter](#parameter-attributes) section below.
range: Parameter
multivalued: true
Expand Down Expand Up @@ -412,7 +414,10 @@ classes:
range: string

Parameter:
description: Defines a configurable parameter for the application.
description: >-
Defines a configurable parameter for the application.
This object is used to build a property bag, i.e. `parameters`, defined in application description.
See `parameters` attribute under [ApplicationDescription Attributes](#top-level-attributes) section for better understanding.
rank: 90
attributes:
name:
Expand Down
10 changes: 6 additions & 4 deletions src/specification/applications/resources/index.md.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -56,18 +56,20 @@ which defines the [desired state](../margo-management-interface/desired-state.md

| Attribute | Type | Required? | Description |
| --- | --- | --- | --- |
{% for slot in gen.get_direct_slots(c)|sort(attribute='rank') -%}
{%- if slot.name != "value" -%}
{%- for slot in gen.get_direct_slots(c)|sort(attribute='rank') %}
{%- if c.name == "Parameter" and slot.name == "name" %}
{%- elif slot.name != "value" %}
| {{ slot.name }} | {{ format_range(slot) }} | {% if slot.required == True %} Y {% else %} N {% endif %} | {{ slot.description }}|
{%- else -%}
{%- else %}
| {{ slot.name }} | <*see description*> | {% if slot.required == True %} Y {% else %} N {% endif %} | {{ slot.description }}|
{%- endif %}
{% endfor %}
{%- endfor %}

{%- endif %}


{%- if c.name.startswith("DeploymentProfile") %}

#### Helm Exceptions

Applications can be deployed as Helm charts using either Helm [version 3](https://helm.sh/docs/v3/topics/charts) or [version 4](https://helm.sh/docs/topics/charts) using Chart APIVersion v2 only.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,10 @@ classes:
required: true
rank: 10
parameters:
description: Describes the configured parameters applied via the end-user.
description: >-
Describes the configured parameters applied via the end-user.
Defined as a map where each key is the parameter name matching a parameter defined in the ApplicationDescription
(e.g., `mysqlDatabase:`, `greeting:`, `idpName:`, `myAppEndpoint:`); unrecognized keys are ignored.
range: Parameter
required: true
multivalued: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -324,9 +324,13 @@ spec:

| Attribute | Type | Required? | Description |
| --- | --- | --- | --- |
{% for slot in gen.get_direct_slots(c)|sort(attribute='rank') -%}
{%- for slot in gen.get_direct_slots(c)|sort(attribute='rank') -%}
{%- set parameters_slot = schemaview.get_slot("parameters") -%}
{%- set is_map_key = parameters_slot and parameters_slot.range == c.name and not parameters_slot.inlined_as_list and slot.identifier %}
{%- if not is_map_key %}
| {{ slot.name }} | {{ format_range(slot) }} | {% if slot.required == True %} Y {% else %} N {% endif %} | {{ slot.description }}|
{% endfor %}
{%- endif %}
{%- endfor %}
{%- endif %}
{%- endfor %}

Expand Down
Loading