Skip to content

Commit b203ecd

Browse files
committed
docs: update README to reflect changes in usage instructions for Docker Compose and Helm Chart
Signed-off-by: Catarina Paralta <clouropa@cisco.com>
1 parent cf09149 commit b203ecd

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -157,35 +157,32 @@ dirctl daemon start
157157
All state is stored under `~/.agntcy/dir/` by default. The daemon listens on `localhost:8888` and can be managed with `dirctl daemon stop` and `dirctl daemon status`.
158158

159159
A custom configuration file can be used to connect to external databases (e.g. PostgreSQL) or remote OCI registries instead of the built-in SQLite and local store:
160-
161160
```bash
162161
dirctl daemon start --config /path/to/daemon.config.yaml
163162
```
164163

165-
### Using Taskfile
164+
### Using Docker Compose
166165

167-
This will start the necessary components such as storage and API services.
166+
This will deploy Directory services (apiserver, reconciler, Zot registry, PostgreSQL) as separate containers using Docker Compose:
168167

169168
```bash
170-
task server:start
169+
cd install/docker
170+
docker compose up -d
171171
```
172172

173-
### Using Helm chart
174-
175-
This will deploy Directory services into an existing Kubernetes cluster.
173+
Contributors working on the Directory codebase can also use the Taskfile wrapper:
176174

177175
```bash
178-
helm pull oci://ghcr.io/agntcy/dir/helm-charts/dir --version v1.1.0
179-
helm upgrade --install dir oci://ghcr.io/agntcy/dir/helm-charts/dir --version v1.1.0
176+
task server:start
180177
```
181178

182-
### Using Docker Compose
179+
### Using Helm Chart
183180

184-
This will deploy Directory services using Docker Compose:
181+
This will deploy Directory services into an existing Kubernetes cluster.
185182

186183
```bash
187-
cd install/docker
188-
docker compose up -d
184+
helm pull oci://ghcr.io/agntcy/dir/helm-charts/dir --version v1.1.0
185+
helm upgrade --install dir oci://ghcr.io/agntcy/dir/helm-charts/dir --version v1.1.0
189186
```
190187

191188
## Copyright Notice

0 commit comments

Comments
 (0)