Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
soapy1 committed Nov 26, 2024
1 parent d9a4a66 commit 14baab2
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 24 deletions.
9 changes: 1 addition & 8 deletions docusaurus-docs/conda-store/explanations/artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,9 @@ To install the tarball, follow the [instructions for the target machine in the c
## Docker images

:::warning
Docker image creation is currently only supported on Linux.

The docker image generation and registry features are experimental,
and the following instructions are not thoroughly tested.
If you face any difficulties, open an issue on the GitHub repository.
Docker image creation is currently not supported.
:::

conda-store acts as a docker registry.
It leverages [Conda Docker][conda-docker], which builds docker images without Docker, allowing for advanced caching, reduced image sizes, and does not require elevated privileges.

### Authentication

The `conda-store` docker registry requires authentication.
Expand Down
3 changes: 1 addition & 2 deletions docusaurus-docs/conda-store/references/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ the following responsibilities:

- build Conda environments from Conda `environment.yaml` specifications
- build Conda pack archives
- build Conda docker images
- remove Conda builds
- modify symlinks to point current environment to given build
- generally any tasks that can take an unbounded amount of time
Expand Down Expand Up @@ -64,7 +63,7 @@ the server:

Both the worker and server need a connection to a SQLAchemy compatible
database, Redis, and S3 compatible object storage. The S3 server is
used to store all build artifacts for example logs, docker layers, and
used to store all build artifacts for example logs, and
the [Conda-Pack](https://conda.github.io/conda-pack/) tarball. The
PostgreSQL database is used for storing all states on environments and
builds along with powering the conda-store web server UI, REST API,
Expand Down
14 changes: 1 addition & 13 deletions docusaurus-docs/conda-store/references/configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,7 @@ to build. By default it is all the artifacts that conda-store is
capable of building. These are the
[lockfile](https://github.com/conda-incubator/conda-lock),
[YAML](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#create-env-file-manually),
[Conda-Pack](https://conda.github.io/conda-pack/), and
[Docker](https://github.com/conda-incubator/conda-docker). Currently
[Conda-Pack](https://conda.github.io/conda-pack/). Currently
the `lockfile` one is ignored since it is always created upon build.

`CondaStore.build_artifacts_kept_on_deletion` is a list of artifacts
Expand Down Expand Up @@ -211,17 +210,6 @@ setting is useful if you want to protect environments from
modification from certain users and groups. Note: this configuration
option is not supported on Windows.

`CondaStore.default_docker_base_image` default base image used for the
Dockerized environments. Make sure to have a proper glibc within image
(highly discourage alpine/musl based images). Can also be callable
function which takes the `orm.Build` object as input which has access
to all attributes about the build such as installed packages, requested
packages, name, namespace, etc. This package at a minimum should have
the [following packages
installed](https://docs.anaconda.com/anaconda/install/linux/). Often
times for non-graphic and non-gpu environments glibc is enough. Hence
the default docker image `library/debian:sid-slim`.

`CondaStore.serialize_builds` DEPRECATED no longer has any effect

`CondaStore.post_update_environment_build_hook` is an optional configurable to
Expand Down
2 changes: 1 addition & 1 deletion docusaurus-docs/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ const FeatureList = [
description: (
<>
Share fully-reproducible environments with auto-generated artifacts like
lockfiles, YAML files, docker images, and tarballs.
lockfiles, YAML files, and tarballs.
</>
),
},
Expand Down

0 comments on commit 14baab2

Please sign in to comment.