Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Document setting environment variable #765

Merged
merged 7 commits into from
Feb 29, 2024
Merged

[DOC] Document setting environment variable #765

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4d523ad
:memo: Add note about env vars
pavithraes Feb 6, 2024
14e374e
Apply suggestions from code review
pavithraes Feb 27, 2024
c46e083
:wrench: Revert changes to setup.md
pavithraes Feb 27, 2024
4dbda44
:memo: Add link to conda docs
pavithraes Feb 27, 2024
b5e6157
Merge branch 'main' into yaml-vars
pavithraes Feb 27, 2024
34559b5
Apply suggestions from code review
trallard Feb 29, 2024
fb29e0f
Merge branch 'main' into yaml-vars
trallard Feb 29, 2024
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
15 changes: 15 additions & 0 deletions docusaurus-docs/conda-store-ui/tutorials/create-envs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,21 @@ To install packages published only on [PyPI][pypi] using [`pip`][pip], include a

-->

### Set environment variables

:::note
This features is in the release *after* conda-store version 2024.1.1.
pavithraes marked this conversation as resolved.
Show resolved Hide resolved

Currently, only the `CONDA_OVERRIDE_CUDA` environment variable is supported to set the CUDA version for GPU-powered workflows.
pavithraes marked this conversation as resolved.
Show resolved Hide resolved
pavithraes marked this conversation as resolved.
Show resolved Hide resolved
:::

You can set environment variables in the YAML-editor with the following syntax:
trallard marked this conversation as resolved.
Show resolved Hide resolved

```yaml
variables:
CONDA_OVERRIDE_CUDA: 12
pavithraes marked this conversation as resolved.
Show resolved Hide resolved
```

## Trigger environment creation

Once the name, description, required packages, and channels are specified, click on the "Create" button at the bottom of the screen to trigger environment creation:
Expand Down
6 changes: 1 addition & 5 deletions docusaurus-docs/conda-store-ui/tutorials/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,9 @@ conda-store-server --standalone

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move changes in this file into a separate PR. To me, these look unrelated to the environment variables change, which means they can be merged separately (and likely much faster as well).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your review :)

I did mention in the PR description that it includes some minor, miscellaneous clean-up, so I thought this would be alright.

However, I do agree we should aim for cleaner+specific PRs. I'll revert these updates.

## Authentication

<!-- TODO: Update images to use Playwright-generated ones -->

While you can view certain namespaces and environments, you need to be logged-in to create and edit environments in conda-store.

Locate the `login` button in the left sidebar, and click on it.
Locate the `Log in` button in the left sidebar, and click on it.

![conda-store-ui with login button highlighted](../images/login.png)

Expand All @@ -64,8 +62,6 @@ The default login combination is:

Once logged-in, you can click on the same button to log-out when needed.

![conda-store-ui authentication screen](../images/authentication.png)

<!-- Internal links -->

[contribution-guidelines]: /community/contribute/contribute-code#linux
Loading