From 8f4cb004ace6d2bd20e3deeef7efdf95b53ae427 Mon Sep 17 00:00:00 2001 From: Colton Padden Date: Wed, 18 Dec 2024 21:12:26 -0500 Subject: [PATCH] rm spaces; use vanilla table; use markdown images --- .../environment-variables/agent-config.mdx | 113 +++++++----------- 1 file changed, 42 insertions(+), 71 deletions(-) diff --git a/docs/docs-beta/docs/dagster-plus/deployment/management/environment-variables/agent-config.mdx b/docs/docs-beta/docs/dagster-plus/deployment/management/environment-variables/agent-config.mdx index 8305e40904e41..2082ef7cae702 100644 --- a/docs/docs-beta/docs/dagster-plus/deployment/management/environment-variables/agent-config.mdx +++ b/docs/docs-beta/docs/dagster-plus/deployment/management/environment-variables/agent-config.mdx @@ -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+. ::: @@ -73,22 +71,17 @@ locations: - "my_tag_name" ``` + + {/* - 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.
- In the example above, FOO_ENV_VAR will be set to{" "} - foo_value and BAR_ENV_VAR will be set to whatever - value it has in the agent task. + In the example above, FOO_ENV_VAR will be set to foo_value and BAR_ENV_VAR will be set to whatever value it has in the agent task. - Individual secrets specified using the{" "} - - same structure as the ECS API - - . + Individual secrets specified using the same structure as the ECS API. A list of tag names. Each secret tagged with any of those tag names in AWS @@ -101,17 +94,31 @@ locations: */} -After you've modified `dagster_cloud.yaml`, redeploy the code location in Dagster+ to apply the changes: - +{/* + + + 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. +
+ In the example above, FOO_ENV_VAR will be set to foo_value and BAR_ENV_VAR will be set to whatever value it has in the agent task. + + + Individual secrets specified using the same structure as the ECS API. + + + 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. + + +*/} + + +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) @@ -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: - +![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) @@ -171,34 +171,20 @@ locations: - database_password ``` -{/* - - - A list of environment variable names to inject into the job, formatted as{" "} - KEY or KEY=VALUE. If only KEY is - specified, the value will be pulled from the current process. - - - A list of secret names, from which environment variables for a job are drawn - using envFrom. Refer to the{" "} - - Kubernetes documentation - {" "} - for more info. - - -*/} + + + + + + + + + +
env_varsenv_secrets
A list of environment variable names to inject into the job, formatted as KEY or KEY=VALUE. If only KEY is specified, the value will be pulled from the current process.A list of secret names, from which environment variables for a job are drawn using envFrom. Refer to the Kubernetes documentation for more info.
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) @@ -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: - + ![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: @@ -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: - - + ![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**.