Skip to content

Commit f84593b

Browse files
committed
docs: update to new namespace config definition
1 parent 25647f3 commit f84593b

1 file changed

Lines changed: 20 additions & 17 deletions

File tree

doc/src/operating-kernel.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,46 +26,49 @@ Pharia Kernel wants to enable teams outside of the Pharia Kernel Operators to de
2626

2727
Each namespace configuration typically would reside in a Git repository owned by the Team which owns the namespace. Changes in this file will be automatically detected by the Kernel.
2828

29-
A namespace is also associated with a registry to load the skills from. These skill registries can either be directories in filesystem (mostly used for a development setup) or point to an OCI registry (recommended for production).
29+
A [namespace](skill-deployment.md#configuring-namespace) is also associated with a registry to load the skills from. These skill registries can either be directories in filesystem (mostly used for a development setup) or point to an OCI registry (recommended for production).
3030

3131
### Namespace with Local Config and Local Registry
3232

3333
```toml
34-
[namespaces.local]
35-
config_url = "file://namespace.toml"
34+
# `my-team` is the name of this namespace
35+
[namespaces.my-team]
36+
# Path to the local namespace configuration file
37+
config-url = "file://namespace.toml"
3638

37-
[namespaces.local.registry]
38-
type = "file"
39+
# Path to the local skill directory
3940
path = "skills"
4041
```
4142

42-
With the local configuration above, Pharia Kernel will serve any skill deployed at the `skills` subdirectory of its working directory under the namespace "local". This is mostly intended for local development of skills without a remote instance of Pharia Kernel. To deploy skills in production it is recommended to use a remote namespace.
43+
With the local configuration above, Pharia Kernel will serve any skill deployed at the `skills` subdirectory of its working directory under the namespace `my-team`. This is mostly intended for local development of skills without a remote instance of Pharia Kernel. To deploy skills in production it is recommended to use a remote namespace.
4344

4445
### Namespace with Remote Config and Remote Registry
4546

4647
```toml
48+
# `my-team` is the name of this namespace
4749
[namespaces.my-team]
4850
# The URL to the configuration listing the skills of this namespace
4951
# Pharia kernel will use the contents of the `NAMESPACES__MY_TEAM__CONFIG_ACCESS_TOKEN` environment variable to access (authorize) the config
50-
config_url = "https://gitlab.aleph-alpha.de/api/v4/projects/966/repository/files/config.toml/raw?ref=main"
51-
52-
# Registry to load skills from
53-
# Pharia kernel will use the contents of the `NAMESPACES__MY_TEAM__REGISTRY__USER` and `NAMESPACES__MY_TEAM__REGISTRY__PASSWORD` environment variables to access (authorize) the registry
54-
[namespaces.my-team.registry]
55-
type = "oci"
56-
name = "registry.gitlab.aleph-alpha.de"
57-
repository = "engineering/pharia-skills/skills"
52+
config-url = "https://github.com/Aleph-Alpha/my-team/blob/main/config.toml"
53+
54+
# OCI Registry to load skills from
55+
# Pharia kernel will use the contents of the `NAMESPACES__MY_TEAM__REGISTRY_USER` and `NAMESPACES__MY_TEAM__REGISTRY_PASSWORD` environment variables to access (authorize) the registry
56+
registry = "registry.acme.com"
57+
58+
# This is the common prefix added to the skill name when composing the OCI repository.
59+
# e.g. ${base-repository}/${skill_name}
60+
base-repository = "my-org/my-team/skills"
5861
```
5962

60-
With the remote configuration above, Pharia Kernel will serve any skill deployed on the specified OCI registry under the namespace "my-team".
63+
With the remote configuration above, Pharia Kernel will serve any skill deployed on the specified OCI registry under the namespace `my-team`.
6164

6265
### Authentication against OCI Registries
6366

6467
You can provide each namespace in Pharia Kernel with credentials to authenticate against the specified OCI registry. Set the environment variables that are expected from the operator config:
6568

6669
```shell
67-
MY_TEAM_REGISTRY_USER=Joe.Plumber
68-
MY_TEAM_REGISTRY_PASSWORD=****
70+
NAMESPACES__MY_TEAM__REGISTRY_USER=Joe.Plumber
71+
NAMESPACES__MY_TEAM__REGISTRY_PASSWORD=****
6972
```
7073

7174
## Update interval

0 commit comments

Comments
 (0)