Skip to content

Commit

Permalink
resolve yarn run lint
Browse files Browse the repository at this point in the history
  • Loading branch information
@cmpadden
cmpadden committed Dec 13, 2024
1 parent c5d1627 commit c8622f0
Showing 1 changed file with 47 additions and 50 deletions.
97 changes: 47 additions & 50 deletions ...ent/environment-variables/agent-config.md → ...nt/environment-variables/agent-config.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,7 @@ To complete the steps in this guide, you'll need:
## Setting environment variables for a code location

:::note
To set environment variables, you need{" "}
<a href="/dagster-plus/account/managing-users">
one of the following user roles
</a>{" "}
in Dagster+:
To set environment variables, you need <a href="/dagster-plus/account/managing-users"> one of the following user roles</a> in Dagster+:

Check warning on line 31 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
<ul>
<li>Organization Admin, or</li>
<li>
Expand Down Expand Up @@ -77,30 +73,32 @@ 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">

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.Terms] Use 'ECS' instead of 'ecs'.

Raw Output:
{"message": "[Vale.Terms] Use 'ECS' instead of 'ecs'.", "location": {"path": "docs/docs-beta/docs/dagster-plus/deployment/management/environment-variables/agent-config.mdx", "range": {"start": {"line": 78, "column": 55}}}, "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.
<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">

Check failure on line 86 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.Terms] Use 'ECS' instead of 'ecs'.

Raw Output:
{"message": "[Vale.Terms] Use 'ECS' instead of 'ecs'.", "location": {"path": "docs/docs-beta/docs/dagster-plus/deployment/management/environment-variables/agent-config.mdx", "range": {"start": {"line": 86, "column": 55}}}, "severity": "ERROR"}
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:
Expand Down Expand Up @@ -173,21 +171,23 @@ 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>-->
{/*
<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>
*/}

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

Expand All @@ -206,12 +206,9 @@ After you've modified `dagster_cloud.yaml`, redeploy the code location in Dagste
## Setting environment variables for full deployments

:::note
If you're a Dagster+{" "}
<a href="/dagster-plus/account/managing-users">
<strong>Editor</strong> or <strong>Admin</strong>
</a>
, you can only set environment variables for full deployments where you're an <strong>
Editor
If you're a Dagster+ <a href="/dagster-plus/account/managing-users"> <strong>Editor</strong> or

Check warning on line 209 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
<strong>Admin</strong> </a> , you can only set environment variables for full deployments where
you're an <strong> Editor
</strong> or <strong>Admin</strong>.
:::

Expand Down

0 comments on commit c8622f0

Please sign in to comment.