Skip to content

Commit

Permalink
Update doc formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@soapy1
soapy1 committed Jan 9, 2025
1 parent d0a77ab commit 24ea2f7
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 23 deletions.
6 changes: 3 additions & 3 deletions conda-store-server/conda_store_server/_internal/server/views/api.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# license that can be found in the LICENSE file.

import datetime
from typing import Any, Dict, List, Optional, TypedDict
from typing import Any, Dict, List, Optional, TypedDict, Callable

import pydantic
import yaml
Expand Down Expand Up @@ -133,14 +133,14 @@ def paginated_api_response(
"count": count,
}

def deprecated(sunset_date: datetime.date):
def deprecated(sunset_date: datetime.date) -> Callable:
"""Decorator to add deprecation headers to a HTTP response. These will include:
{
Deprecation: True
Sunset: <sunset_date>
}
See the conda-store backwards compatibility policy for appropriate use of
See the conda-store backwards compatibility policy for appropriate use of
deprecations https://conda.store/community/policies/backwards-compatibility.
Parameters
Expand Down
5 changes: 3 additions & 2 deletions docusaurus-docs/conda-store/explanations/artifacts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,9 @@ To install the tarball, follow the [instructions for the target machine in the c

## Docker images (deprecated)

:::warning
Docker image creation is currently not supported.
:::warning[Deprecation notice]
Docker image creation is currently not supported. This feature is scheduled to be
removed March 17, 2025.
:::

### Authentication
Expand Down
36 changes: 18 additions & 18 deletions docusaurus-docs/conda-store/references/configuration-options.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: conda-store configuration options

# Configuration options

### Traitlets
## Traitlets

:::warning
This page is in active development, content may be inaccurate and incomplete.
Expand All @@ -24,7 +24,7 @@ conda-store-server --config <path-to-conda-store-config.py>
conda-store-worker --config <path-to-conda-store-config.py>
```

### Data directory
## Data directory

The `CONDA_STORE_DIR` Python variable specifies the conda-store data directory,
which is used by some of the configuration options mentioned below, like
Expand All @@ -49,7 +49,7 @@ Please use the conda-store configuration options mentioned below instead.

[platformdirs]: https://github.com/platformdirs/platformdirs

### `conda_store_server._internal.app.CondaStore`
## `conda_store_server._internal.app.CondaStore`

`CondaStore.storage_class` configures the storage backend to use for
storing build artifacts from
Expand Down Expand Up @@ -216,11 +216,11 @@ allow for custom behavior that will run after an environment's current build cha
`CondaStore.lock_backend` is the name of the default lock plugin to use
when locking a conda environment. By default, conda-store uses [conda-lock](https://github.com/conda/conda-lock).

#### Deprecated configuration options for `conda_store_server._internal.app.CondaStore`
### Deprecated configuration options for `conda_store_server._internal.app.CondaStore`

`CondaStore.serialize_builds` no longer has any effect

### `conda_store_server.storage.S3Storage`
## `conda_store_server.storage.S3Storage`

conda-store uses [minio-py](https://github.com/minio/minio-py) as a
client to connect to S3 "like" object stores.
Expand Down Expand Up @@ -266,7 +266,7 @@ credentials class.
`S3Storage.credentials_kwargs` keyword arguments to pass for creation
of credentials class.

### `conda_store_server.storage.LocalStorage`
## `conda_store_server.storage.LocalStorage`

`LocalStorage.storage_path` is the base directory to use for storing
build artifacts.
Expand All @@ -275,7 +275,7 @@ build artifacts.
artifacts. This url assumes that the base will be a static server
serving `LocalStorage.storage_path`.

### `conda_store_server.server.auth.AuthenticationBackend`
## `conda_store_server.server.auth.AuthenticationBackend`

`AuthenticationBackend.secret` is the symmetric secret to use for
encrypting tokens.
Expand All @@ -289,7 +289,7 @@ in a similar manner to how things are done with jupyterhub. Format for
the values is a dictionary with keys being the tokens and values being
the `schema.AuthenticaitonToken` all fields are optional.

### `conda_store_server.server.auth.AuthorizationBackend`
## `conda_store_server.server.auth.AuthorizationBackend`

`AuthorizationBackend.role_mappings` is a dictionary that maps `roles`
to application `permissions`. There are three default roles at the
Expand All @@ -302,7 +302,7 @@ bindings that an unauthenticated user assumes.
`AuthorizationBackend.authenticated_role_bindings` are the base role
bindings that an authenticated user assumes.

### `conda_store_server.server.auth.Authentication`
## `conda_store_server.server.auth.Authentication`

`Authentication.cookie_name` is the name for the browser cookie used
to authenticate users.
Expand All @@ -322,7 +322,7 @@ likely not need to change.
`Authentication.login_html` is the HTML to display for a given user as
the login form.

### `conda_store_server.server.auth.DummyAuthentication`
## `conda_store_server.server.auth.DummyAuthentication`

Has all the configuration settings of `Authetication`. This class is
modeled after the [JupyterHub DummyAuthentication
Expand All @@ -332,7 +332,7 @@ class](https://github.com/jupyterhub/jupyterhub/blob/9f3663769e96d2e4f665fd6ef48
login with. Effectively a static password. This rarely if ever should
be used outside of testing.

### `conda_store_server.server.auth.GenericOAuthAuthentication`
## `conda_store_server.server.auth.GenericOAuthAuthentication`

A provider-agnostic OAuth authentication provider. Configure
endpoints, secrets and other parameters to enable any OAuth-compatible
Expand Down Expand Up @@ -369,7 +369,7 @@ especially useful when web service is behind a proxy.
`GenericOAuthAuthentication.tls_verify` to optionally turn of TLS
verification useful for custom signed certificates.

### `conda_store_server.server.auth.GithubOAuthAuthentication`
## `conda_store_server.server.auth.GithubOAuthAuthentication`

Inherits from `Authentication` and `GenericOAuthAuthentication` so
should be fully configurable from those options.
Expand All @@ -380,15 +380,15 @@ is `https://github.com`.
`GithubOAuthAuthentication.github_api` is the REST API url for
GitHub. Default is `https://api.github.com`.

### `conda_store_server.server.auth.JupyterHubOAuthAuthentication`
## `conda_store_server.server.auth.JupyterHubOAuthAuthentication`

Inherits from `Authentication` and `GenericOAuthAuthentication` so
should be fully configurable from those options.

`GithubOAuthAuthentication.jupyterhub_url` is the url for connecting
to JupyterHub. The URL should not include the `/hub/`.

### `conda_store_server.server.auth.RBACAuthorizationBackend`
## `conda_store_server.server.auth.RBACAuthorizationBackend`

`RBACAuthorizationBackend.role_mappings_version` specifies the role mappings
version to use: 1 (default, legacy), 2 (new, recommended).
Expand Down Expand Up @@ -433,7 +433,7 @@ metadata and set the roles:
PUT /api/v1/namespace/{namespace}/
```

### `conda_store_server._internal.server.app.CondaStoreServer`
## `conda_store_server._internal.server.app.CondaStoreServer`

`CondaStoreServer.log_level` is the level for all server
logging. Default is `INFO`. Common options are `DEBUG`, `INFO`,
Expand Down Expand Up @@ -484,15 +484,15 @@ to serve in form `[(path, method, function), ...]`. `path` is a
string, `method` is `get`, `post`, `put`, `delete` etc. and function
is a regular python fastapi function.

#### Deprecated configuration options for `conda_store_server._internal.server.app.CondaStoreServer`
### Deprecated configuration options for `conda_store_server._internal.server.app.CondaStoreServer`

`CondaStoreServer.enable_registry` (deprecated) a Boolean on whether to
expose the registry endpoints. Default False.

`CondaStoreServer.registry_external_url` (deprecated) is the external hostname
and port to access docker registry cannot contain `http://` or `https://`.

### `conda_store_server._internal.worker.app.CondaStoreWorker`
## `conda_store_server._internal.worker.app.CondaStoreWorker`

`CondaStoreWorker.log_level` is the level for all server
logging. Default is `INFO`. Common options are `DEBUG`, `INFO`,
Expand All @@ -506,6 +506,6 @@ single filename to watch.
the number of threads on your given machine. If set will limit the
number of concurrent celery tasks to the integer.

### (deprecated) `conda_store_server.registry.ContainerRegistry`
## (deprecated) `conda_store_server.registry.ContainerRegistry`

`ContainerRegistry.container_registries` (deprecated) dictionary of registries_url to upload built container images with callable function to configure registry instance with credentials.

0 comments on commit 24ea2f7

Please sign in to comment.