Skip to content

template st2client conf #262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arm4b merged 6 commits into from
Nov 10, 2021
Merged

template st2client conf #262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3265932
template st2client config
cognifloyd Nov 1, 2021
afb98d8
add envFromSecrets to generate-st2client-config initContainers
cognifloyd Nov 1, 2021
9887e57
add changelog entry
cognifloyd Nov 1, 2021
e46fa50
correct docstring
cognifloyd Nov 1, 2021
e2fad0b
Merge branch 'master' into template-st2client-conf
cognifloyd Nov 9, 2021
9929d15
include st2clientConfig link
cognifloyd Nov 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* Refactor deployments/jobs to inject st2 username/password via `envFrom` instead of via `env`. (#257) (by @cognifloyd)
* New feature: Add `envFromSecrets` to `st2actionrunner`, `st2client`, `st2sensorcontainer`, and jobs. This is useful for adding custom secrets to the environment. This complements the `extra_volumes` feature (loading secrets as files) to facilitate loading secrets that are not easily injected via the filesystem. (#259) (by @cognifloyd)
* New feature to include `nodeSelector`, `affinity` and `tolerations` to `st2client`, allowing more flexibility to pod positioning. (#263) (by @sandesvitor)
* Template `~/.st2/config`. This allows customizing the settings used by the `st2client` and jobs pods for using the st2 apis. (#262) (by @cognifloyd)

## v0.70.0
* New feature: Shared packs volumes `st2.packs.volumes`. Allow using cluster-specific persistent volumes to store packs, virtualenvs, and (optionally) configs. This enables using `st2 pack install`. It even works with `st2packs` images in `st2.packs.images`. (#199) (by @cognifloyd)
Expand Down
8 changes: 5 additions & 3 deletions templates/deployments.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1490,6 +1490,10 @@ spec:
name: {{ .Release.Name }}-st2-urls
- secretRef:
name: {{ .Release.Name }}-st2-auth
{{- range .Values.st2client.envFromSecrets }}
- secretRef:
name: {{ . }}
{{- end }}
volumeMounts:
- name: st2client-config-vol
mountPath: /root/.st2/
Expand All @@ -1499,9 +1503,7 @@ spec:
- '-ec'
- |
cat <<EOT > /root/.st2/config
[credentials]
username = ${ST2_AUTH_USERNAME}
password = ${ST2_AUTH_PASSWORD}
{{- tpl .Values.st2client.st2clientConfig . | nindent 12 }}
EOT
containers:
- name: st2client
Expand Down
16 changes: 10 additions & 6 deletions templates/jobs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,10 @@ spec:
name: {{ .Release.Name }}-st2-urls
- secretRef:
name: {{ .Release.Name }}-st2-auth
{{- range .Values.jobs.envFromSecrets }}
- secretRef:
name: {{ . }}
{{- end }}
volumeMounts:
- name: st2client-config-vol
mountPath: /root/.st2/
Expand All @@ -166,9 +170,7 @@ spec:
- '-ec'
- |
cat <<EOT > /root/.st2/config
[credentials]
username = ${ST2_AUTH_USERNAME}
password = ${ST2_AUTH_PASSWORD}
{{- tpl .Values.jobs.st2clientConfig . | nindent 12 }}
EOT
containers:
- name: st2-apikey-load
Expand Down Expand Up @@ -273,6 +275,10 @@ spec:
name: {{ .Release.Name }}-st2-urls
- secretRef:
name: {{ .Release.Name }}-st2-auth
{{- range .Values.jobs.envFromSecrets }}
- secretRef:
name: {{ . }}
{{- end }}
volumeMounts:
- name: st2client-config-vol
mountPath: /root/.st2/
Expand All @@ -282,9 +288,7 @@ spec:
- '-ec'
- |
cat <<EOT > /root/.st2/config
[credentials]
username = ${ST2_AUTH_USERNAME}
password = ${ST2_AUTH_PASSWORD}
{{- tpl .Values.jobs.st2clientConfig . | nindent 12 }}
EOT
containers:
- name: st2-key-load
Expand Down
18 changes: 18 additions & 0 deletions values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -623,6 +623,15 @@ st2sensorcontainer:
# The st2client deployment/pod simplifies ad-hoc administration.
# st2client is a special purpose actionrunner pod, but you can customize it separately
st2client:
# st2client config (~/.st2/config) template.
# see: https://docs.stackstorm.com/reference/cli.html#configuration-file
# You can access env variables here because this is used in a bash heredoc.
Copy link
Member

@arm4b arm4b Nov 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!
Let's just include a link to https://docs.stackstorm.com/reference/cli.html#configuration-file in comments for both Helm value definitions.

That'll help users find the use cases and configuration examples easily.

Copy link
Member Author

@cognifloyd cognifloyd Nov 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

# For example, you could use a var injected with envFromSecrets.
# Note that Helm templating is supported in this block!
st2clientConfig: |
[credentials]
username = ${ST2_AUTH_USERNAME}
password = ${ST2_AUTH_PASSWORD}
env: {}
# HTTP_PROXY: http://proxy:1234
## These named secrets (managed outside this chart) will be added to envFrom.
Expand Down Expand Up @@ -729,6 +738,15 @@ st2chatops:
## Various batch jobs (apply-rbac-definitions, apikey-load, key-load, register-content)
##
jobs:
# st2client config (~/.st2/config) template for jobs that need it.
# see: https://docs.stackstorm.com/reference/cli.html#configuration-file
# You can access env variables here because this is used in a bash heredoc.
# For example, you could use a var injected with envFromSecrets.
# Note that Helm templating is supported in this block!
st2clientConfig: |
[credentials]
username = ${ST2_AUTH_USERNAME}
password = ${ST2_AUTH_PASSWORD}
annotations: {}
# Override default image settings (for now, only tag can be overridden)
# The Jobs use the st2actionrunner image
Expand Down