Skip to content

Commit 670ce59

Browse files
jdstonejdstone
authored
Fix OTS chart to use correct host port (#15)
* Fix OTS chart to use correct host port * Fixed OTS typos and missing comments for params
1 parent 2f4b7dd commit 670ce59

File tree

4 files changed

+51
-43
lines changed

4 files changed

+51
-43
lines changed

‎charts/onetimesecret/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: onetimesecret
3-
version: 0.12.1
3+
version: 0.12.2
44
description: A Helm chart for One-Time Secret server
55
type: application
66
keywords:

‎charts/onetimesecret/README.md

+36-36
Original file line numberDiff line numberDiff line change
@@ -51,42 +51,42 @@ The command removes all the Kubernetes components associated with the chart and
5151

5252
### Common parameters
5353

54-
| Name | Type | Description | Default |
55-
| ------------------- | ------ | ------------------------------------------------------------------------- | ------- |
56-
| `kubeVersion` | string | Override Kubernetes version | `nil` |
57-
| `nameOverride` | string | Partially override names.fullname | `nil` |
58-
| `fullnameOverride` | string | Fully override names.fullname | `nil` |
59-
| `commonLabels` | object | Labels to add to all deployed objects | `{}` |
60-
| `commonAnnotations` | object | Annotations to add to all deployed objects | `{}` |
61-
| `networkPort` | int | Deployment container, Deployment livenessProbe, Ingress, and Service port | `3000` |
54+
| Name | Type | Description | Default |
55+
| ------------------ | ------ | ------------------------------------------------------------------------- | ------- |
56+
| `kubeVersion` | string | Override Kubernetes version | `nil` |
57+
| `nameOverride` | string | Partially override names.fullname | `nil` |
58+
| `fullnameOverride` | string | Fully override names.fullname | `nil` |
59+
| `commonLabels` | object | Labels to add to all deployed objects | `{}` |
60+
| `networkPort` | int | Deployment container, Deployment livenessProbe, Ingress, and Service port | `3000` |
6261

6362

6463
### One-Time Secret configuration parameters
6564

66-
| Name | Type | Description | Default |
67-
| ---------------------------------------- | ------- | ----------------------------------------------------------------------------------- | --------------------------- |
68-
| `configuration.host` | string | OTS host (the domain you will access OTS at) | `"localhost"` |
69-
| `configuration.ssl` | boolean | Enable SSL (HTTPS) support | `false` |
70-
| `configuration.baseRedisUrl` | string | Base Redis URL (see values.yaml for more info) | `""` |
71-
| `configuration.colonels` | string | OTS account created with this email is automatically considered admin of the system | `""` |
72-
| `configuration.secret` | string | Used to encrypt OTS secrets - don't forget this, save it somewhere safe | `"CHANGEME"` |
73-
| `configuration.emailer.sendgridEnabled` | boolean | Use SendGrid to allow OTS the ability to send emails | `false` |
74-
| `configuration.emailer.smtpEnabled` | boolean | Use SMTP to allow OTS the ability to send emails | `false` |
75-
| `configuration.emailer.from` | string | SendGrid/SMTP email sender "from" email address | `""` |
76-
| `configuration.emailer.sendgridAccount` | string | SendGrid account login | `"CHANGEME"` |
77-
| `configuration.emailer.sendgridPassword` | string | SendGrid account password | `"CHANGEME"` |
78-
| `configuration.emailer.sendgridFromName` | string | SendGrid email sender "From" name | `"CHANGEME"` |
79-
| `configuration.emailer.sendgridBcc` | string | SendGrid email BCC field | `nil` |
80-
| `configuration.emailer.smtpHost` | string | SMTP hostname | `"localhost"` |
81-
| `configuration.emailer.smtpPort` | int | SMTP port | `587` |
82-
| `configuration.emailer.smtpTls` | boolean | Enable/Disable TLS for SMTP | `false` |
83-
| `configuration.emailer.smtpUser` | string | SMTP username | `nil` |
84-
| `configuration.emailer.smtpPass` | string | SMTP password | `nil` |
85-
| `configuration.emailer.smtpAuth` | string | SMTP authentication type. Allowed values: `plain` or `login` | `nil` |
86-
| `configuration.incoming.enabled` | boolean | Intended for use by IT support teams who need someone to send them sensitive info | `false` |
87-
| `configuration.incoming.email` | string | Where the secret link is sent | `"CHANGEME@example.com"` |
88-
| `configuration.incoming.passphrase` | string | Used to protect the "secret" | `"CHANGEME"` |
89-
| `configuration.incoming.regex` | string | Used to ensure the ticket number is valid | `'\A[a-zA-Z0-9]{6}\z'` |
65+
| Name | Type | Description | Default |
66+
| ---------------------------------------- | ------- | ----------------------------------------------------------------------------------- | ------------------------ |
67+
| `configuration.host` | string | OTS host (the domain you will access OTS at) | `"localhost"` |
68+
| `configuration.hostPort` | int | OTS host port (the HTTP port used to access OTS) | `nil` |
69+
| `configuration.ssl` | boolean | Enable SSL (HTTPS) support | `false` |
70+
| `configuration.baseRedisUrl` | string | Base Redis URL (see values.yaml for more info) | `""` |
71+
| `configuration.colonels` | string | OTS account created with this email is automatically considered admin of the system | `""` |
72+
| `configuration.secret` | string | Used to encrypt OTS secrets - don't forget this, save it somewhere safe | `"CHANGEME"` |
73+
| `configuration.emailer.sendgridEnabled` | boolean | Use SendGrid to allow OTS the ability to send emails | `false` |
74+
| `configuration.emailer.smtpEnabled` | boolean | Use SMTP to allow OTS the ability to send emails | `false` |
75+
| `configuration.emailer.from` | string | SendGrid/SMTP email sender "from" email address | `""` |
76+
| `configuration.emailer.sendgridAccount` | string | SendGrid account login | `"CHANGEME"` |
77+
| `configuration.emailer.sendgridPassword` | string | SendGrid account password | `"CHANGEME"` |
78+
| `configuration.emailer.sendgridFromName` | string | SendGrid email sender "From" name | `"CHANGEME"` |
79+
| `configuration.emailer.sendgridBcc` | string | SendGrid email BCC field | `nil` |
80+
| `configuration.emailer.smtpHost` | string | SMTP hostname | `"localhost"` |
81+
| `configuration.emailer.smtpPort` | int | SMTP port | `587` |
82+
| `configuration.emailer.smtpTls` | boolean | Enable/Disable TLS for SMTP | `false` |
83+
| `configuration.emailer.smtpUser` | string | SMTP username | `nil` |
84+
| `configuration.emailer.smtpPass` | string | SMTP password | `nil` |
85+
| `configuration.emailer.smtpAuth` | string | SMTP authentication type. Allowed values: `plain` or `login` | `nil` |
86+
| `configuration.incoming.enabled` | boolean | Intended for use by IT support teams who need someone to send them sensitive info | `false` |
87+
| `configuration.incoming.email` | string | Where the secret link is sent | `"CHANGEME@example.com"` |
88+
| `configuration.incoming.passphrase` | string | Used to protect the "secret" | `"CHANGEME"` |
89+
| `configuration.incoming.regex` | string | Used to ensure the ticket number is valid | `'\A[a-zA-Z0-9]{6}\z'` |
9090

9191

9292
### Deployment parameters
@@ -116,10 +116,10 @@ The command removes all the Kubernetes components associated with the chart and
116116

117117
### Service parameters
118118

119-
| Name | Type | Description | Default |
120-
| ---------------| ------- | ------------------------------------------- | ------------ |
121-
| `service.port` | int | OTS Service port (overrides `networkPort`) | `nil` |
122-
| `service.type` | string | OTS Service Type | `"NodePort"` |
119+
| Name | Type | Description | Default |
120+
| ---------------| ------ | ------------------------------------------ | ------------ |
121+
| `service.port` | int | OTS Service port (overrides `networkPort`) | `nil` |
122+
| `service.type` | string | OTS Service Type | `"NodePort"` |
123123

124124

125125
### Ingress parameters

‎charts/onetimesecret/templates/configmap.yaml

+6-2
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,12 @@ metadata:
1010
data:
1111
config: |
1212
:site:
13-
:host: {{ print .Values.configuration.host ":" .Values.networkPort | squote }}
14-
:domain: {{ required "'configuration.host' is required!" .Values.configuration.host }}
13+
{{- if .Values.configuration.hostPort }}
14+
:host: {{ print .Values.configuration.host ":" .Values.configuration.hostPort | squote }}
15+
{{- else }}
16+
:host: {{ .Values.configuration.host | squote }}
17+
{{- end }}
18+
:domain: {{ required "'configuration.host' is required!" .Values.configuration.host | squote }}
1519
:ssl: <%= {{ .Values.configuration.ssl | squote }} == 'true' %>
1620
:secret: <%= ENV['ONETIMESECRET_SECRET'] || 'CHANGEME' %>
1721
:redis:

‎charts/onetimesecret/values.yaml

+8-4
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
## @section Common parameters
22

3-
## @param kubeVersion Override Kubernetes version
3+
## @param {string} kubeVersion - Override Kubernetes version
44
##
55
kubeVersion:
6-
## @param nameOverride String to partially override names.fullname
6+
## @param {string} nameOverride - Partially override `names.fullname`
77
##
88
nameOverride:
9-
## @param fullnameOverride String to fully override names.fullname
9+
## @param {string} fullnameOverride - Fully override `names.fullname`
1010
##
1111
fullnameOverride:
12-
## @param commonLabels Labels to add to all deployed objects
12+
## @param {object} commonLabels - Labels to add to all deployed objects
1313
##
1414
commonLabels: {}
1515

@@ -20,6 +20,10 @@ configuration:
2020
## @param {string} configuration.host - Host/domain for accessing the website
2121
##
2222
host: "localhost"
23+
## @param {int} configuration.hostPort - Host/domain port for accessing the website
24+
## Set a port if using something other than port 80
25+
##
26+
hostPort:
2327
## @param {boolean} configuration.ssl - Enable/disable SSL support
2428
##
2529
ssl: false

0 commit comments

Comments
 (0)