Skip to content

Commit

Permalink
Updated chart readme and values.yaml with tls config
Browse files Browse the repository at this point in the history
Signed-off-by: Benjamin Hettwer <[email protected]>
  • Loading branch information
benjaminhettwer committed Aug 13, 2024
1 parent 1e88861 commit 206a9ba
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
17 changes: 11 additions & 6 deletions charts/ephemeral/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ helm install --name my-release -f values.yaml ephemeral
| `discovery.service.annotations` | Annotations that should be attached to the Discovery service | `[]` |
| `discovery.frontendUrl` | The external base URL of the VCP | \`\` |
| `discovery.master.port` | The port of the master discovery service instance | \`\` |
| `discovery.tls.enabled` | Determines whether the service communicates over TLS or plaintext | `false` |

Check notice on line 97 in charts/ephemeral/README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

charts/ephemeral/README.md#L97

Expected: 80; Actual: 152
| `discovery.tls.secret` | The name of the k8s secret that holds the TLS keys and certificates | \`\` |

Check notice on line 98 in charts/ephemeral/README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

charts/ephemeral/README.md#L98

Expected: 80; Actual: 152
| `discovery.isMaster` | Determines whether the service acts as master or slave | `true` |
| `discovery.slave.connectTimeout` | Timeout to establish the connection to the upstream master Discovery Service | `60s` |
Expand All @@ -102,12 +103,14 @@ helm install --name my-release -f values.yaml ephemeral

### Network Controller

| Parameter | Description | Default |
| ------------------------------------ | ---------------------------------------------------------------- | ------------------------------------------- |
| `networkController.image.registry` | Image registry used to pull the Network Controller Service image | `ghcr.io` |
| `networkController.image.repository` | Network Controller Image name | `carbynestack/ephemeral/network-controller` |
| `networkController.image.tag` | Network Controller Image tag | `latest` |
| `networkController.image.pullPolicy` | Network Controller Image pull policy | `IfNotPresent` |
| Parameter | Description | Default |
| ------------------------------------ | ------------------------------------------------------------------- | ------------------------------------------- |
| `networkController.image.registry` | Image registry used to pull the Network Controller Service image | `ghcr.io` |

Check notice on line 108 in charts/ephemeral/README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

charts/ephemeral/README.md#L108

Expected: 80; Actual: 153
| `networkController.image.repository` | Network Controller Image name | `carbynestack/ephemeral/network-controller` |

Check notice on line 109 in charts/ephemeral/README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

charts/ephemeral/README.md#L109

Expected: 80; Actual: 153
| `networkController.image.tag` | Network Controller Image tag | `latest` |

Check notice on line 110 in charts/ephemeral/README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

charts/ephemeral/README.md#L110

Expected: 80; Actual: 153
| `networkController.image.pullPolicy` | Network Controller Image pull policy | `IfNotPresent` |

Check notice on line 111 in charts/ephemeral/README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

charts/ephemeral/README.md#L111

Expected: 80; Actual: 153
| `networkController.tls.enabled` | Determines whether the service communicates over TLS or plaintext | `false` |
| `networkController.tls.secret` | The name of the k8s secret that holds the TLS keys and certificates | \`\` |

### Ephemeral Service

Expand All @@ -134,6 +137,8 @@ helm install --name my-release -f values.yaml ephemeral
| `ephemeral.discovery.port` | The port of the discovery service | `8080` |
| `ephemeral.discovery.connectTimout` | Timeout to establish the connection to the discovery service | `60s` |
| `ephemeral.frontendUrl` | The external base URL of the VCP | \`\` |
| `ephemeral.tls.enabled` | Determines whether the service communicates over TLS or plaintext | `false` |
| `ephemeral.tls.secret` | The name of the k8s secret that holds the TLS keys and certificates | \`\` |
| `ephemeral.spdz.prime` | The prime used by SPDZ | \`\` |
| `ephemeral.spdz.rInv` | The rInv used by SPDZ | \`\` |
| `ephemeral.spdz.gfpMacKey` | The macKey for the prime protocol used by SPDZ | \`\` |
Expand Down
4 changes: 4 additions & 0 deletions charts/ephemeral/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ discovery:
slave:
connectTimeout: "60s"
tls:
enabled: false
secret:

ephemeral:
Expand Down Expand Up @@ -58,6 +59,9 @@ ephemeral:
path: "/"
tupleStock: 1000
frontendUrl:
tls:
enabled: false
secret:
discovery:
host: discovery.default.svc.cluster.local
port: 8080
Expand Down

0 comments on commit 206a9ba

Please sign in to comment.