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.

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

docs: Add S3 documentation #2835

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: Add S3 documentation #2835

wants to merge 3 commits into from

Conversation

pavelzw
Copy link
Contributor

@pavelzw pavelzw commented Jan 4, 2025

follow-up of #2825, xref conda/rattler#960

cc @olivier-lacroix, @delsner, @moritzwilksch, @ruben-arts, @baszalmstra, @wolfv

Please take a look at this implementation and tell me what you think of it

docs/advanced/s3.md Outdated Show resolved Hide resolved
Copy link

@moritzwilksch moritzwilksch left a comment

Choose a reason for hiding this comment

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

amazing! some remarks on wording

channels = ["s3://my-bucket/custom-channel"]
```

In the bucket, you need to have the following structure:

Choose a reason for hiding this comment

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

Suggested change
In the bucket, you need to have the following structure:
In the bucket, your objects need to adhere to the standard conda repository structure:

custom-channel/
noarch/
repodata.json
...

Choose a reason for hiding this comment

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

add linux-64 too?

Comment on lines +23 to +24
- Using AWS credentials from environment variables, AWS configuration files, ... like in any other AWS tool
- Using pixi's configuration in combination with storing the credentials in pixi's authentication storage

Choose a reason for hiding this comment

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

Suggested change
- Using AWS credentials from environment variables, AWS configuration files, ... like in any other AWS tool
- Using pixi's configuration in combination with storing the credentials in pixi's authentication storage
1. Using AWS credentials from environment variables or AWS configuration files, like in any other AWS tool
2. Using pixi's configuration in combination with storing the credentials in pixi's authentication storage

- Using pixi's configuration in combination with storing the credentials in pixi's authentication storage

!!! warning ""
This is an either/or situation.

Choose a reason for hiding this comment

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

Suggested change
This is an either/or situation.
These two options are mutually exclusive!

!!! warning ""
This is an either/or situation.
Specifying `s3-options` (see below) will deactivate the AWS credentials fetching.
You can either use the AWS credentials (by not specifying `s3-options`) or from pixi's authentication storage (by specifying `s3-options`).

Choose a reason for hiding this comment

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

Suggested change
You can either use the AWS credentials (by not specifying `s3-options`) or from pixi's authentication storage (by specifying `s3-options`).
You can either use the AWS credentials from the conventional locations (by not specifying `s3-options`) or from pixi's authentication storage (by specifying `s3-options`).

## Using pixi's configuration

You can specify the `project.s3-options` in your `pixi.toml` file.
This might be especially useful if you want to use a custom S3-compatible host and not use AWS's configuration.

Choose a reason for hiding this comment

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

Suggested change
This might be especially useful if you want to use a custom S3-compatible host and not use AWS's configuration.
This might be useful when you want to use a custom S3-compatible host and not AWS's configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants