Skip to content

Commit

Permalink
use markdown tables
Browse files Browse the repository at this point in the history
  • Loading branch information
@cmpadden
cmpadden committed Dec 19, 2024
1 parent 8f4cb00 commit e4518e0
Showing 1 changed file with 10 additions and 54 deletions.
64 changes: 10 additions & 54 deletions .../docs/dagster-plus/deployment/management/environment-variables/agent-config.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,50 +71,11 @@ locations:
- "my_tag_name"
```
{/*
<ReferenceTable>
<ReferenceTableItem propertyName="container_context.ecs.env_vars">
A list of keys or key-value pairs to include in the task. If a value is not specified, the value will be pulled from the agent task.
<br />
In the example above, <code>FOO_ENV_VAR</code> will be set to <code>foo_value</code> and <code>BAR_ENV_VAR</code> will be set to whatever value it has in the agent task.
</ReferenceTableItem>
<ReferenceTableItem propertyName="container_context.ecs.secrets">
Individual secrets specified using the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Secret.html">same structure as the ECS API</a>.
</ReferenceTableItem>
<ReferenceTableItem propertyName="container_context.ecs.secrets_tags">
A list of tag names. Each secret tagged with any of those tag names in AWS
Secrets Manager will be included in the launched tasks as environment
variables. The name of the environment variable will be the name of the
secret, and the value of the environment variable will be the value of the
secret.
</ReferenceTableItem>
</ReferenceTable>
*/}
{/*
<ReferenceTable>
<ReferenceTableItem propertyName="container_context.ecs.env_vars">
A list of keys or key-value pairs to include in the task. If a value is not specified, the value will be pulled from the agent task.
<br />
In the example above, <code>FOO_ENV_VAR</code> will be set to <code>foo_value</code> and <code>BAR_ENV_VAR</code> will be set to whatever value it has in the agent task.
</ReferenceTableItem>
<ReferenceTableItem propertyName="container_context.ecs.secrets">
Individual secrets specified using the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Secret.html">same structure as the ECS API</a>.
</ReferenceTableItem>
<ReferenceTableItem propertyName="container_context.ecs.secrets_tags">
A list of tag names. Each secret tagged with any of those tag names in AWS
Secrets Manager will be included in the launched tasks as environment
variables. The name of the environment variable will be the name of the
secret, and the value of the environment variable will be the value of the
secret.
</ReferenceTableItem>
</ReferenceTable>
*/}
| Key | Description |
|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `container_context.ecs.env_vars` | A list of keys or key-value pairs. If a value is not specified, it pulls from the agent task. E.g., `FOO_ENV_VAR` = `foo_value`, `BAR_ENV_VAR` = agent task value. |

Check warning on line 76 in docs/docs-beta/docs/dagster-plus/deployment/management/environment-variables/agent-config.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Dagster.latin] Use 'for example' instead of 'E.g.', but consider rewriting the sentence.

Raw Output:
{"message": "[Dagster.latin] Use 'for example' instead of 'E.g.', but consider rewriting the sentence.", "location": {"path": "docs/docs-beta/docs/dagster-plus/deployment/management/environment-variables/agent-config.mdx", "range": {"start": {"line": 76, "column": 136}}}, "severity": "WARNING"}
| `container_context.ecs.secrets` | Individual secrets using the [ECS API structure](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Secret.html). |
| `container_context.ecs.secrets_tags` | A list of tag names; secrets tagged with these in AWS Secrets Manager will be environment variables. The variable name is the secret name, the value is the secret's value. |

After you've modified `dagster_cloud.yaml`, redeploy the code location in Dagster+ to apply the changes:

Expand Down Expand Up @@ -171,16 +132,11 @@ locations:
- database_password
```

<table>
<tr>
<th>env_vars</th>
<th>env_secrets</th>
</tr>
<tr>
<td>A list of environment variable names to inject into the job, formatted as <code>KEY</code> or <code>KEY=VALUE</code>. If only <code>KEY</code> is specified, the value will be pulled from the current process.</td>
<td>A list of secret names, from which environment variables for a job are drawn using <code>envFrom</code>. Refer to the <a href="https://kubernetes.io/docs/tasks/inject-data-application/distribute-credentials-secure/#configure-all-key-value-pairs-in-a-secret-as-container-environment-variables">Kubernetes documentation</a> for more info.</td>
</tr>
</table>
| Key | Description |
|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `env_vars` | A list of environment variable names to inject into the job, formatted as <code>KEY</code> or <code>KEY=VALUE</code>. If only <code>KEY</code> is specified, the value will be pulled from the current process. |
| `env_secrets` | A list of secret names, from which environment variables for a job are drawn using <code>envFrom</code>. Refer to the <a href="https://kubernetes.io/docs/tasks/inject-data-application/distribute-credentials-secure/#configure-all-key-value-pairs-in-a-secret-as-container-environment-variables">Kubernetes documentation</a> for more info. |

Check warning on line 138 in docs/docs-beta/docs/dagster-plus/deployment/management/environment-variables/agent-config.mdx

View workflow job for this annotation

GitHub Actions / deploy 

Do not use an `<a>` element to navigate. Use the `<Link />` component from `@docusaurus/Link` instead. See: https://docusaurus.io/docs/docusaurus-core#link


After you've modified `dagster_cloud.yaml`, redeploy the code location in Dagster+ to apply the changes:

Expand Down

0 comments on commit e4518e0

Please sign in to comment.