Skip to content

Commit

Permalink
docs: add self-signed certs config (#169)
Browse files Browse the repository at this point in the history
* feat: rename certs to cert in client config

Signed-off-by: Gaius <[email protected]>

* docs: add self-signed certs config

Signed-off-by: Gaius <[email protected]>

---------

Signed-off-by: Gaius <[email protected]>
  • Loading branch information
gaius-qi authored Oct 16, 2024
1 parent f45dabf commit 3843bfc
Show file tree
Hide file tree
Showing 14 changed files with 125 additions and 171 deletions.
6 changes: 2 additions & 4 deletions docs/development-guide/configure-development-nvironment.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,7 @@ Configuration content is as follows:
```yaml
# Seed Peer configuration.
manager:
addrs:
- http://127.0.0.1:65003
addr: http://127.0.0.1:65003
seedPeer:
enable: true
type: super
Expand Down Expand Up @@ -187,8 +186,7 @@ Configuration content is as follows:
```yaml
# Peer configuration.
manager:
addrs:
- http://127.0.0.1:65003
addr: http://127.0.0.1:65003
```
Run Dfdaemon as Peer:
Expand Down
6 changes: 2 additions & 4 deletions docs/getting-started/installation/binaries.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,8 +336,7 @@ Configuration content is as follows:
```yaml
# Seed Peer configuration.
manager:
addrs:
- http://dragonfly-manager:65003
addr: http://dragonfly-manager:65003
seedPeer:
enable: true
type: super
Expand Down Expand Up @@ -376,8 +375,7 @@ Configuration content is as follows:
```yaml
# Peer configuration.
manager:
addrs:
- http://dragonfly-manager:65003
addr: http://dragonfly-manager:65003
```
Run Dfdaemon as Peer:
Expand Down
6 changes: 2 additions & 4 deletions docs/getting-started/quick-start/multi-cluster-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,8 +346,7 @@ seedClient:
config:
verbose: true
manager:
addrs:
- http://dragonfly-manager.cluster-a.svc.cluster.local:65003
addr: http://dragonfly-manager.cluster-a.svc.cluster.local:65003
seedPeer:
clusterID: 2

Expand Down Expand Up @@ -378,8 +377,7 @@ client:
host:
idc: cluster-2
manager:
addrs:
- http://dragonfly-manager.cluster-a.svc.cluster.local:65003
addr: http://dragonfly-manager.cluster-a.svc.cluster.local:65003

manager:
enable: false
Expand Down
18 changes: 8 additions & 10 deletions docs/operations/integrations/container-runtime/containerd.md
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ seedClient:
proxy:
registryMirror:
addr: https://yourdomain.com
certs: /etc/certs/yourdomain.crt
cert: /etc/certs/yourdomain.crt
extraVolumes:
- name: seed-client-secret
secret:
Expand All @@ -537,7 +537,7 @@ client:
proxy:
registryMirror:
addr: https://yourdomain.com
certs: /etc/certs/yourdomain.crt
cert: /etc/certs/yourdomain.crt
extraVolumes:
- name: client-secret
secret:
Expand Down Expand Up @@ -611,8 +611,7 @@ refer to [Dfdaemon](../../../reference/configuration/client/dfdaemon.md).

```shell
manager:
addrs:
- http://dragonfly-manager:65003
addr: http://dragonfly-manager:65003
seedPeer:
enable: true
type: super
Expand All @@ -624,10 +623,10 @@ proxy:
# configuration to pull the image. The `X-Dragonfly-Registry` header can instead of the default address
# of registry mirror.
addr: https://yourdomain.com
## certs is the client certs path with PEM format for the registry.
## cert is the client cert path with PEM format for the registry.
## If registry use self-signed cert, the client should set the
## cert for the registry mirror.
certs: /etc/certs/yourdomain.crt
cert: /etc/certs/yourdomain.crt
```
##### Setup Dfdaemon as Peer and configure self-signed certificate
Expand All @@ -637,19 +636,18 @@ refer to [Dfdaemon](../../../reference/configuration/client/dfdaemon.md).

```shell
manager:
addrs:
- http://dragonfly-manager:65003
addr: http://dragonfly-manager:65003
proxy:
registryMirror:
# addr is the default address of the registry mirror. Proxy will start a registry mirror service for the
# client to pull the image. The client can use the default address of the registry mirror in
# configuration to pull the image. The `X-Dragonfly-Registry` header can instead of the default address
# of registry mirror.
addr: https://yourdomain.com
## certs is the client certs path with PEM format for the registry.
## cert is the client cert path with PEM format for the registry.
## If registry use self-signed cert, the client should set the
## cert for the registry mirror.
certs: /etc/certs/yourdomain.crt
cert: /etc/certs/yourdomain.crt
```
##### Configure containerd self-signed certificate
Expand Down
18 changes: 8 additions & 10 deletions docs/operations/integrations/container-runtime/cri-o.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ seedClient:
proxy:
registryMirror:
addr: https://yourdomain.com
certs: /etc/certs/yourdomain.crt
cert: /etc/certs/yourdomain.crt
extraVolumes:
- name: seed-client-secret
secret:
Expand All @@ -340,7 +340,7 @@ client:
proxy:
registryMirror:
addr: https://yourdomain.com
certs: /etc/certs/yourdomain.crt
cert: /etc/certs/yourdomain.crt
extraVolumes:
- name: client-secret
secret:
Expand Down Expand Up @@ -414,8 +414,7 @@ refer to [Dfdaemon](../../../reference/configuration/client/dfdaemon.md).

```shell
manager:
addrs:
- http://dragonfly-manager:65003
addr: http://dragonfly-manager:65003
seedPeer:
enable: true
type: super
Expand All @@ -427,10 +426,10 @@ proxy:
# configuration to pull the image. The `X-Dragonfly-Registry` header can instead of the default address
# of registry mirror.
addr: https://yourdomain.com
## certs is the client certs path with PEM format for the registry.
## cert is the client cert path with PEM format for the registry.
## If registry use self-signed cert, the client should set the
## cert for the registry mirror.
certs: /etc/certs/yourdomain.crt
cert: /etc/certs/yourdomain.crt
```
##### Setup Dfdaemon as Peer and configure self-signed certificate
Expand All @@ -440,19 +439,18 @@ refer to [Dfdaemon](../../../reference/configuration/client/dfdaemon.md).

```shell
manager:
addrs:
- http://dragonfly-manager:65003
addr: http://dragonfly-manager:65003
proxy:
registryMirror:
# addr is the default address of the registry mirror. Proxy will start a registry mirror service for the
# client to pull the image. The client can use the default address of the registry mirror in
# configuration to pull the image. The `X-Dragonfly-Registry` header can instead of the default address
# of registry mirror.
addr: https://yourdomain.com
## certs is the client certs path with PEM format for the registry.
## cert is the client cert path with PEM format for the registry.
## If registry use self-signed cert, the client should set the
## cert for the registry mirror.
certs: /etc/certs/yourdomain.crt
cert: /etc/certs/yourdomain.crt
```
##### Configure CRI-O self-signed certificate
Expand Down
2 changes: 0 additions & 2 deletions docs/operations/integrations/container-runtime/nydus.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,6 @@ client:
enable: true
config:
verbose: true
security:
enable: true
proxy:
prefetch: true
server:
Expand Down
2 changes: 0 additions & 2 deletions docs/operations/integrations/container-runtime/stargz.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,6 @@ client:
enable: true
config:
verbose: true
security:
enable: true
proxy:
prefetch: true
server:
Expand Down
2 changes: 0 additions & 2 deletions docs/operations/integrations/git-lfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,6 @@ client:
enable: true
config:
verbose: true
security:
enable: true
proxy:
server:
port: 4001
Expand Down
2 changes: 0 additions & 2 deletions docs/operations/integrations/hugging-face.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,6 @@ client:
enable: true
config:
verbose: true
security:
enable: true
proxy:
server:
port: 4001
Expand Down
2 changes: 0 additions & 2 deletions docs/operations/integrations/torchserve.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,6 @@ client:
enable: true
config:
verbose: true
security:
enable: true
proxy:
server:
port: 4001
Expand Down
2 changes: 0 additions & 2 deletions docs/operations/integrations/triton-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,6 @@ client:
enable: true
config:
verbose: true
security:
enable: true
proxy:
server:
port: 4001
Expand Down
Loading

0 comments on commit 3843bfc

Please sign in to comment.