Skip to content

Commit

Permalink
rm spaces; use vanilla table; use markdown images
Browse files Browse the repository at this point in the history
  • Loading branch information
@cmpadden
cmpadden committed Dec 19, 2024
1 parent 74dcbbc commit 8f4cb00
Showing 1 changed file with 42 additions and 71 deletions.
113 changes: 42 additions & 71 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 @@ -4,8 +4,6 @@ sidebar_position: 300
sidebar_label: "Set with agent config"
---

import ThemedImage from '@theme/ThemedImage';

:::note
This guide is applicable to Dagster+.
:::
Expand Down Expand Up @@ -73,22 +71,17 @@ locations:
- "my_tag_name"
```
{/*
<ReferenceTable>
<ReferenceTableItem propertyName="container_context.ecs.env_vars">

Check failure on line 78 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 🐶
[Vale.Spelling] Did you really mean 'env_vars'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'env_vars'?", "location": {"path": "docs/docs-beta/docs/dagster-plus/deployment/management/environment-variables/agent-config.mdx", "range": {"start": {"line": 78, "column": 59}}}, "severity": "ERROR"}

Check failure on line 78 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.spelling] Is 'env_vars' spelled correctly?

Raw Output:
{"message": "[Dagster.spelling] Is 'env_vars' spelled correctly?", "location": {"path": "docs/docs-beta/docs/dagster-plus/deployment/management/environment-variables/agent-config.mdx", "range": {"start": {"line": 78, "column": 59}}}, "severity": "ERROR"}
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.
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.
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>
.
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
Expand All @@ -101,17 +94,31 @@ locations:
*/}
After you've modified `dagster_cloud.yaml`, redeploy the code location in Dagster+ to apply the changes:
<ThemedImage
alt="Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+"
style={{width:'100%', height: 'auto'}}
sources={{
light: '/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png',
dark: '/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png',
}}
/>
{/*
<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>
*/}
After you've modified `dagster_cloud.yaml`, redeploy the code location in Dagster+ to apply the changes:

!["Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+"](/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png)

</TabItem>
<TabItem value="Docker">
Expand All @@ -138,14 +145,7 @@ The `container_context.docker.env_vars` property is a list, where each item can

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

<ThemedImage
alt="Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+"
style={{width:'100%', height: 'auto'}}
sources={{
light: '/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png',
dark: '/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png',
}}
/>
![Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+](/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png)

</TabItem>
<TabItem value="Kubernetes">
Expand All @@ -171,34 +171,20 @@ locations:
- database_password
```

{/*
<ReferenceTable>
<ReferenceTableItem propertyName="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.
</ReferenceTableItem>
<ReferenceTableItem propertyName="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.
</ReferenceTableItem>
</ReferenceTable>
*/}
<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>

Check warning on line 181 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
</tr>
</table>

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

<ThemedImage
alt="Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+"
style={{width:'100%', height: 'auto'}}
sources={{
light: '/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png',
dark: '/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png',
}}
/>
![Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+](/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png)

</TabItem>
</Tabs>
Expand Down Expand Up @@ -235,14 +221,7 @@ To make environment variables accessible to a full deployment with an Amazon ECS

6. In the section displaying the template YAML, locate the `AgentTaskDefinition` section:

<ThemedImage
alt="Highlighted AgentTaskDefinition section of the AWS ECS agent CloudFormation template in the AWS Console"
style={{width:'100%', height: 'auto'}}
sources={{
light: '/images/dagster-cloud/developing-testing/environment-variables/aws-ecs-cloudformation-template.png',
dark: '/images/dagster-cloud/developing-testing/environment-variables/aws-ecs-cloudformation-template.png',
}}
/>
![Highlighted AgentTaskDefinition section of the AWS ECS agent CloudFormation template in the AWS Console](/images/dagster-cloud/developing-testing/environment-variables/aws-ecs-cloudformation-template.png)


7. In the `user_code_launcher.config` portion of the `AgentTaskDefinition` section, add the environment variables as follows:
Expand All @@ -266,15 +245,7 @@ To make environment variables accessible to a full deployment with an Amazon ECS

8. When finished, click the **Create Stack** button:

<ThemedImage
alt="Highlighted Create Stack button in the AWS Console"
style={{width:'100%', height: 'auto'}}
sources={{
light: '/images/dagster-cloud/developing-testing/environment-variables/aws-ecs-save-template.png',
dark: '/images/dagster-cloud/developing-testing/environment-variables/aws-ecs-save-template.png',
}}
/>

![Highlighted Create Stack button in the AWS Console](/images/dagster-cloud/developing-testing/environment-variables/aws-ecs-save-template.png)

9. You'll be redirected back to the **Update stack** wizard, where the new template will be populated. Click **Next**.

Expand Down

0 comments on commit 8f4cb00

Please sign in to comment.