Skip to content

Commit ad71aaa

Browse files
authored
Merge branch 'master' into label-helper
2 parents 2997164 + b6419e6 commit ad71aaa

24 files changed

+465
-14
lines changed

.circleci/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ jobs:
5555
resource_class: large
5656
machine:
5757
# Available images https://circleci.com/docs/2.0/configuration-reference/#available-machine-images
58-
image: ubuntu-1604:201903-01
58+
image: ubuntu-2204:2022.04.1
5959
steps:
6060
- checkout
6161
- kubernetes/install

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
# Changelog
22

33
## In Development
4+
5+
## v0.100.0
6+
* Switch st2 to `v3.7` as a new default stable version (#274)
7+
* Upgrade MongoDB `v4.0` -> `v4.4` as 4.0 has reached its EOL. (#304)
8+
* Migrate from `python 3.6` `Ubuntu Bionic` to `python 3.8` `Ubuntu Focal` as a base StackStorm OS (StackStorm/st2-dockerfiles#54)
9+
* Add support for use of overrides that are available in `v3.7` of st2 via helm charts. (#306)
10+
11+
## v0.90.0
412
* Advanced Feature: Make securityContext (on Deployments/Jobs) and podSecurityContext (on Pods) configurable. This allows dropping all capabilities, for example. You can override the securityContext for `st2actionrunner`, `st2sensorcontainer`, and `st2client` if your actions or sensors need, for example, additional capabilites that the rest of StackStorm does not need. (#271) (by @cognifloyd)
513
* Prefix template helpers with chart name and format helper comments as template comments. (#272) (by @cognifloyd)
614
* New feature: Add `extra_volumes` to all python-based st2 deployments. This can facilitate changing log levels by loading logging conf file(s) from a custom ConfigMap. (#276) (by @cognifloyd)

Chart.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
apiVersion: v2
22
# StackStorm version which refers to Docker images tag
3-
appVersion: "3.6"
3+
appVersion: "3.7"
44
name: stackstorm-ha
5-
version: 0.80.0
5+
version: 0.100.0
66
description: StackStorm K8s Helm Chart, optimized for running StackStorm in HA environment.
77
home: https://stackstorm.com/
88
icon: https://landscape.cncf.io/logos/stack-storm.svg
99
source:
10-
- https://github.com/stackstorm/stackstorm-ha
10+
- https://github.com/stackstorm/stackstorm-k8s
1111
keywords:
1212
- st2
1313
- stackstorm

LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2018 The StackStorm Authors.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# `stackstorm-ha` Helm Chart
2-
[![Build Status](https://circleci.com/gh/StackStorm/stackstorm-ha/tree/master.svg?style=shield)](https://circleci.com/gh/StackStorm/stackstorm-ha)
2+
[![Build Status](https://circleci.com/gh/StackStorm/stackstorm-k8s/tree/master.svg?style=shield)](https://circleci.com/gh/StackStorm/stackstorm-k8s)
33
[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/stackstorm-ha)](https://artifacthub.io/packages/helm/stackstorm/stackstorm-ha)
44

55
K8s Helm Chart for running StackStorm cluster in HA mode.
@@ -357,8 +357,8 @@ Please refer to stackstorm-ha's default values.yaml file for examples.
357357

358358
## Extending this chart
359359
If you have any suggestions or ideas about how to extend this chart functionality,
360-
we welcome you to collaborate in [Issues](https://github.com/stackstorm/stackstorm-ha/issues)
361-
and contribute via [Pull Requests](https://github.com/stackstorm/stackstorm-ha/pulls).
360+
we welcome you to collaborate in [Issues](https://github.com/stackstorm/stackstorm-k8s/issues)
361+
and contribute via [Pull Requests](https://github.com/stackstorm/stackstorm-k8s/pulls).
362362
However if you need something very custom and specific to your infra that doesn't fit official chart plans,
363363
we strongly recommend you to create a parent Helm chart with custom K8s objects and referencing `stackstorm-ha` chart
364364
as a child dependency.

templates/_helpers.tpl

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,23 @@ define this here as well to simplify comparison with packs-volume-mounts
241241
{{- end }}
242242
{{- end -}}
243243

244+
#Inserted for override ability to happen via helm charts
245+
246+
{{- define "stackstorm-ha.overrides-config-mounts" -}}
247+
{{- if .Values.st2.overrides }}
248+
- name: st2-overrides-vol
249+
mountPath: /opt/stackstorm/overrides
250+
{{- end }}
251+
{{- end -}}
252+
253+
{{- define "stackstorm-ha.overrides-configs" -}}
254+
{{- if .Values.st2.overrides }}
255+
- name: st2-overrides-vol
256+
configMap:
257+
name: {{ .Release.Name }}-st2-overrides-configs
258+
{{- end }}
259+
{{- end -}}
260+
244261
{{/*
245262
For custom st2packs-initContainers reduce duplicity by defining them here once
246263
Merge packs and virtualenvs from st2 with those from st2packs images

templates/configmaps_overrides.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{{- if .Values.st2.overrides }}
2+
---
3+
apiVersion: v1
4+
kind: ConfigMap
5+
metadata:
6+
name: {{ .Release.Name }}-st2-overrides-configs
7+
annotations:
8+
description: StackStorm override configs defined in helm values, shipped in (or copied to) '/opt/stackstorm/overrides'
9+
labels:
10+
app: st2
11+
tier: backend
12+
vendor: stackstorm
13+
chart: {{ .Chart.Name }}-{{ .Chart.Version }}
14+
release: {{ .Release.Name }}
15+
heritage: {{ .Release.Service }}
16+
data:
17+
{{ toYaml .Values.st2.overrides | indent 2 }}
18+
{{- end }}

templates/deployments.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1518,6 +1518,9 @@ spec:
15181518
checksum/auth: {{ include (print $.Template.BasePath "/secrets_st2auth.yaml") . | sha256sum }}
15191519
checksum/ssh: {{ include (print $.Template.BasePath "/secrets_ssh.yaml") . | sha256sum }}
15201520
checksum/datastore-key: {{ include (print $.Template.BasePath "/secrets_datastore_crypto_key.yaml") . | sha256sum }}
1521+
{{- if .Values.st2.overrides }}
1522+
checksum/overrides: {{ include (print $.Template.BasePath "/configmaps_overrides.yaml") . | sha256sum }}
1523+
{{- end }}
15211524
{{- if .Values.st2client.postStartScript }}
15221525
checksum/post-start-script: {{ .Values.st2client.postStartScript | sha256sum }}
15231526
{{- end }}
@@ -1591,6 +1594,7 @@ spec:
15911594
- name: st2-rbac-mappings-vol
15921595
mountPath: /opt/stackstorm/rbac/mappings/
15931596
{{- end }}
1597+
{{- include "stackstorm-ha.overrides-config-mounts" . | nindent 8 }}
15941598
- name: st2client-config-vol
15951599
mountPath: /root/.st2/
15961600
- name: st2-ssh-key-vol
@@ -1642,6 +1646,7 @@ spec:
16421646
configMap:
16431647
name: {{ .Release.Name }}-st2-rbac-mappings
16441648
{{- end }}
1649+
{{- include "stackstorm-ha.overrides-configs" . | nindent 8 }}
16451650
- name: st2client-config-vol
16461651
emptyDir:
16471652
medium: Memory

templates/jobs.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,9 @@ spec:
368368
# TODO: Investigate/propose running Helm hook only on condition when ConfigMap or Secret has changed
369369
checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") . | sha256sum }}
370370
checksum/packs: {{ include (print $.Template.BasePath "/configmaps_packs.yaml") . | sha256sum }}
371+
{{- if .Values.st2.overrides }}
372+
checksum/overrides: {{ include (print $.Template.BasePath "/configmaps_overrides.yaml") . | sha256sum }}
373+
{{- end }}
371374
{{- if .Values.jobs.annotations }}
372375
{{- toYaml .Values.jobs.annotations | nindent 8 }}
373376
{{- end }}
@@ -426,12 +429,14 @@ spec:
426429
{{- end }}
427430
{{- end }}
428431
volumeMounts:
432+
{{- include "stackstorm-ha.overrides-config-mounts" . | nindent 8 }}
429433
{{- include "stackstorm-ha.st2-config-volume-mounts" . | nindent 8 }}
430434
{{- include "stackstorm-ha.packs-volume-mounts-for-register-job" . | nindent 8 }}
431435
{{- include "stackstorm-ha.pack-configs-volume-mount" . | nindent 8 }}
432436
# TODO: Find out default resource limits for this specific service (#5)
433437
#resources:
434438
volumes:
439+
{{- include "stackstorm-ha.overrides-configs" . | nindent 8 }}
435440
{{- include "stackstorm-ha.st2-config-volume" . | nindent 8 }}
436441
{{- include "stackstorm-ha.packs-volumes" . | nindent 8 }}
437442
{{- include "stackstorm-ha.pack-configs-volume" . | nindent 8 }}
@@ -480,6 +485,9 @@ spec:
480485
annotations:
481486
checksum/config: {{ include (print $.Template.BasePath "/configmaps_st2-conf.yaml") $ | sha256sum }}
482487
checksum/packs: {{ include (print $.Template.BasePath "/configmaps_packs.yaml") $ | sha256sum }}
488+
{{- if $.Values.st2.overrides }}
489+
checksum/overrides: {{ include (print $.Template.BasePath "/configmaps_overrides.yaml") $ | sha256sum }}
490+
{{- end }}
483491
{{- if $.Values.jobs.annotations }}
484492
{{- toYaml $.Values.jobs.annotations | nindent 8 }}
485493
{{- end }}
@@ -545,6 +553,7 @@ spec:
545553
volumeMounts:
546554
- name: st2client-config-vol
547555
mountPath: /root/.st2/
556+
{{- include "stackstorm-ha.overrides-config-mounts" $ | nindent 8 }}
548557
{{- include "stackstorm-ha.st2-config-volume-mounts" $ | nindent 8 }}
549558
{{- include "stackstorm-ha.packs-volume-mounts-for-register-job" $ | nindent 8 }}
550559
{{- include "stackstorm-ha.pack-configs-volume-mount" $ | nindent 8 }}
@@ -555,6 +564,7 @@ spec:
555564
- name: st2client-config-vol
556565
emptyDir:
557566
medium: Memory
567+
{{- include "stackstorm-ha.overrides-configs" $ | nindent 8 }}
558568
{{- include "stackstorm-ha.st2-config-volume" $ | nindent 8 }}
559569
{{- include "stackstorm-ha.packs-volumes" $ | nindent 8 }}
560570
{{- include "stackstorm-ha.pack-configs-volume" $ | nindent 8 }}

0 commit comments

Comments
 (0)