Skip to content

Commit 953cef5

Browse files
stackable-botVladislav Supalov
stackable-bot
and
Vladislav Supalov
committed
Update templated files to rev f19219f (#164)
Automatically created PR based on commit f19219fe21f2e4d1a87b8ef6b24f2cefc377757b in stackabletech/operator-templating repo. Triggered by: Daily run triggered Co-authored-by: Vladislav Supalov <[email protected]>
1 parent 5c82e66 commit 953cef5

File tree

19 files changed

+365
-16
lines changed

19 files changed

+365
-16
lines changed

‎.github/ISSUE_TEMPLATE/new_version.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Not all of these steps are necessary for all versions.
2929

3030
- [ ] Update the Docker image
3131
- [ ] Update documentation to include supported version(s)
32+
- [ ] Update and test getting started guide with updated version(s)
3233
- [ ] Update operator to support the new version (if needed)
3334
- [ ] Update integration tests to test use the new versions (in addition or replacing old versions
3435
- [ ] Update examples to use new versions

‎.github/workflows/build.yml

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,31 @@ jobs:
245245
with:
246246
command: test
247247

248+
# Similar to check_charts, this tries to render the README, and see if there are unintended changes.
249+
# This will save us from merging changes to the wrong file (instead of the templated source), and from
250+
# forgetting to render out modifications to the README.
251+
check_readme:
252+
name: Check if committed README is the one we would render from the available parts
253+
runs-on: ubuntu-latest
254+
steps:
255+
- name: Checkout
256+
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3.0.2
257+
with:
258+
submodules: recursive
259+
- uses: actions/setup-python@v4
260+
with:
261+
python-version: '3.10'
262+
- name: Regenerate charts
263+
run: make render-readme
264+
- name: Check if committed README were up to date
265+
run: git diff --exit-code
266+
- name: Git Diff showed uncommitted changes
267+
if: ${{ failure() }}
268+
uses: actions/github-script@d50f485531ba88479582bc2da03ff424389af5c1 # tag=v6
269+
with:
270+
script: |
271+
core.setFailed('Committed README are not up to date, please make sure to apply them to the templated partials, and re-commit!')
272+
248273
# This job cleans up the CRDs, Helm charts and Kustomize manifests, followed by rebuilding them
249274
# It then runs a `git diff` and fails the entire workflow, if any difference is encountered.
250275
#
@@ -292,7 +317,7 @@ jobs:
292317
run: git diff --exit-code
293318
- name: Git Diff showed uncommitted changes
294319
if: ${{ failure() }}
295-
uses: actions/github-script@d50f485531ba88479582bc2da03ff424389af5c1 # tag=v6
320+
uses: actions/github-script@7dff1a87643417cf3b95bb10b29f4c4bc60d8ebd # tag=v6
296321
with:
297322
script: |
298323
core.setFailed('Committed charts were not up to date, please regenerate and re-commit!')

‎.github/workflows/reviewdog.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
runs-on: ubuntu-latest
1515
steps:
1616
- uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3.0.2
17-
- uses: reviewdog/action-actionlint@12f228ecba8c567a103efafb3fb0bf5b60dc16b7 # tag=v1.27.0
17+
- uses: reviewdog/action-actionlint@fe5c2db6029881e0b5634d7cb0d119b0c16b6922 # tag=v1.32.0
1818
with:
1919
github_token: ${{ secrets.GITHUB_TOKEN }}
2020

@@ -41,9 +41,10 @@ jobs:
4141
runs-on: ubuntu-latest
4242
steps:
4343
- uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # tag=v3.0.2
44-
- uses: reviewdog/action-markdownlint@b8f945b8bee2a2967214f35956209bc31d3c4d26 # tag=v0.7.1
44+
- uses: reviewdog/action-markdownlint@97e3df02fe1573d505a7b268046a44fa5409cbc3 # tag=v0.9.0
4545
with:
4646
github_token: ${{ secrets.GITHUB_TOKEN }}
47+
markdownlint_flags: '-i README.md .'
4748

4849
shellcheck:
4950
runs-on: ubuntu-latest

‎.readme/README.md.j2

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{%- set title="Stackable Operator for Apache Spark" -%}
2+
{%- set operator_name="spark-k8s" -%}
3+
{%- set related_reading_links=[] -%}
4+
5+
{% include "partials/borrowed/header.md.j2" %}
6+
{% include "partials/borrowed/links.md.j2" %}
7+
8+
{% include "partials/main.md.j2" %}
9+
10+
{% include "partials/borrowed/footer.md.j2" %}
11+
12+
{% include "partials/borrowed/related_reading.md.j2" %}

‎.readme/partials/borrowed/documentation.md.j2

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Documentation
2+
3+
The stable documentation for this operator can be found [here](https://docs.stackable.tech/{{operator_name}}/stable/index.html).
4+
If you are interested in the most recent state of this repository, check out the [nightly docs](https://docs.stackable.tech/{{operator_name}}/nightly/index.html) instead.
5+
6+
The documentation for all Stackable products can be found at [docs.stackable.tech](https://docs.stackable.tech).

‎.readme/partials/borrowed/footer.md.j2

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
## About The Stackable Data Platform
2+
3+
This operator is written and maintained by [Stackable](https://www.stackable.tech) and it is part of a larger data platform.
4+
5+
![Stackable Data Platform Overview](./.readme/static/borrowed/sdp_overview.png)
6+
7+
Stackable makes it easy to operate data applications in any Kubernetes cluster.
8+
9+
The data platform offers many operators, new ones being added continuously. All our operators are designed and built to be easily interconnected and to be consistent to work with.
10+
11+
The [Stackable GmbH](https://stackable.tech/) is the company behind the Stackable Data Platform. Offering professional services, paid support plans and custom development.
12+
13+
We love open-source!
14+
15+
## Supported Platforms
16+
17+
We develop and test our operators on the following cloud platforms:
18+
19+
* Kubernetes 1.21-1.24
20+
* EKS on Amazon Web Services (AWS)
21+
* GKE on Google Cloud Platform (GCP)
22+
* AKS on Microsoft Azure
23+
* K3s
24+
25+
We are currently working to support:
26+
27+
* OpenShift
28+
29+
## Other Operators
30+
31+
These are the operators that are currently part of the Stackable Data Platform:
32+
33+
- [Stackable Operator for Apache Airflow](https://github.com/stackabletech/airflow-operator)
34+
- [Stackable Operator for Apache Druid](https://github.com/stackabletech/druid-operator)
35+
- [Stackable Operator for Apache HBase](https://github.com/stackabletech/hbase-operator)
36+
- [Stackable Operator for Apache Hadoop HDFS](https://github.com/stackabletech/hdfs-operator)
37+
- [Stackable Operator for Apache Hive](https://github.com/stackabletech/hive-operator)
38+
- [Stackable Operator for Apache Kafka](https://github.com/stackabletech/kafka-operator)
39+
- [Stackable Operator for Apache NiFi](https://github.com/stackabletech/nifi-operator)
40+
- [Stackable Operator for Apache Spark](https://github.com/stackabletech/spark-k8s-operator)
41+
- [Stackable Operator for Apache Superset](https://github.com/stackabletech/superset-operator)
42+
- [Stackable Operator for Trino](https://github.com/stackabletech/trino-operator)
43+
- [Stackable Operator for Apache ZooKeeper](https://github.com/stackabletech/zookeeper-operator)
44+
45+
And our internal operators:
46+
47+
- [Commons Operator](https://github.com/stackabletech/commons-operator)
48+
- [Listener Operator](https://github.com/stackabletech/listener-operator)
49+
- [OpenPolicyAgent Operator](https://github.com/stackabletech/opa-operator)
50+
- [Secret Operator](https://github.com/stackabletech/secret-operator)
51+
52+
## Contributing
53+
54+
Contributions are welcome. Follow our [Contributors Guide](https://docs.stackable.tech/home/stable/contributor/index.html) to learn how you can contribute.
55+
56+
## License
57+
58+
[Open Software License version 3.0](./LICENSE).
59+
60+
## Support
61+
62+
You can use this project under different licenses. Get started with the community edition! If you want professional support, [we offer subscription plans](https://stackable.tech/en/plans/).

‎.readme/partials/borrowed/header.md.j2

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<p align="center">
2+
<img width="150" src="./.readme/static/borrowed/Icon_Stackable.svg" alt="Stackable Logo"/>
3+
</p>
4+
5+
<h1 align="center">{{title}}</h1>

‎.readme/partials/borrowed/links.md.j2

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[![Build Actions Status](https://ci.stackable.tech/job/{{operator_name}}%2doperator%2dit%2dnightly/badge/icon?subject=Integration%20Tests)](https://ci.stackable.tech/job/{{operator_name}}%2doperator%2dit%2dnightly)
2+
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/stackabletech/{{operator_name}}-operator/graphs/commit-activity)
3+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://docs.stackable.tech/home/stable/contributor/index.html)
4+
[![License OSL3.0](https://img.shields.io/badge/license-OSL3.0-green)](./LICENSE)
5+
6+
[Documentation](https://docs.stackable.tech/{{operator_name}}-operator/stable/index.html) {% if quickstart_link %}| [Quickstart]({{quickstart_link}}) {% endif %}| [Stackable Data Platform](https://stackable.tech/) | [Platform Docs](https://docs.stackable.tech/)

‎.readme/partials/borrowed/related_reading.md.j2

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{%- if related_reading_links -%}
2+
## Related Reading
3+
{% for (text, link) in related_reading_links %}
4+
* [{{text}}]({{link}})
5+
{%- endfor %}
6+
{%- endif -%}

‎.readme/partials/main.md.j2

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
This is a Kubernetes operator to manage [Apache Spark](https://spark.apache.org/) jobs.
2+
3+
It is part of the Stackable Data Platform, a curated selection of the best open source data apps like Kafka, Druid, Trino or Spark, [all](#other-operators) working together seamlessly. Based on Kubernetes, it runs everywhere – [on prem or in the cloud]((#supported-platforms)).
4+
5+
## Installation
6+
7+
You can install the operator using [stackablectl or helm](https://docs.stackable.tech/{{operator_name}}/stable/getting_started/installation.html).
8+
9+
Read on to get started with it, or see it in action in one of our [demos](https://stackable.tech/en/demos/).
10+
11+
## Getting Started
12+
13+
You can follow this [tutorial](https://docs.stackable.tech/{{operator_name}}/stable/getting_started/first_steps.html).
14+
15+
{% include "partials/borrowed/documentation.md.j2" %}

‎.readme/static/borrowed/Icon_Stackable.svg

Lines changed: 20 additions & 0 deletions
Loading

‎.readme/static/borrowed/sdp_overview.png

214 KB
Loading

‎Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
# This script requires https://github.com/mikefarah/yq (not to be confused with https://github.com/kislyuk/yq)
77
# It is available from Nixpkgs as `yq-go` (`nix shell nixpkgs#yq-go`)
8+
# This script also requires `jq` https://stedolan.github.io/jq/
89

910
.PHONY: docker chart-lint compile-chart
1011

@@ -19,6 +20,9 @@ export VERSION IS_NIGHTLY DOCS_VERSION
1920

2021
SHELL=/usr/bin/env bash -euo pipefail
2122

23+
render-readme:
24+
scripts/render_readme.sh
25+
2226
## Docker related targets
2327
docker-build:
2428
docker build --force-rm --build-arg VERSION=${VERSION} -t "docker.stackable.tech/stackable/spark-k8s-operator:${VERSION}" -f docker/Dockerfile .

‎README.md

Lines changed: 91 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,96 @@
1-
# Stackable Operator for Apache Spark
1+
<p align="center">
2+
<img width="150" src="./.readme/static/borrowed/Icon_Stackable.svg" alt="Stackable Logo"/>
3+
</p>
24

3-
[![Build Actions Status](https://ci.stackable.tech/job/spark%2dk8s%2doperator%2dit%2dnightly/badge/icon?subject=Integration%20Tests)](https://ci.stackable.tech/job/spark%2dk8s%2doperator%2dit%2dnightly)
4-
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/stackabletech/spark-k8s-operator/graphs/commit-activity)
5+
<h1 align="center">Stackable Operator for Apache Spark</h1>
6+
[![Build Actions Status](https://ci.stackable.tech/job/spark-k8s%2doperator%2dit%2dnightly/badge/icon?subject=Integration%20Tests)](https://ci.stackable.tech/job/spark-k8s%2doperator%2dit%2dnightly)
7+
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/stackabletech/spark-k8s-operator/graphs/commit-activity)
8+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://docs.stackable.tech/home/stable/contributor/index.html)
9+
[![License OSL3.0](https://img.shields.io/badge/license-OSL3.0-green)](./LICENSE)
510

6-
This is a Kubernetes Operator to manage [Apache Spark](https://spark.apache.org/) jobs.
11+
[Documentation](https://docs.stackable.tech/spark-k8s-operator/stable/index.html) | [Stackable Data Platform](https://stackable.tech/) | [Platform Docs](https://docs.stackable.tech/)
712

8-
It is written by [Stackable](https://www.stackable.tech) in Rust.
13+
This is a Kubernetes operator to manage [Apache Spark](https://spark.apache.org/) jobs.
914

10-
The documentation for this operator can be found at <https://docs.stackable.tech/spark-k8s/stable/index.html>.
15+
It is part of the Stackable Data Platform, a curated selection of the best open source data apps like Kafka, Druid, Trino or Spark, [all](#other-operators) working together seamlessly. Based on Kubernetes, it runs everywhere – [on prem or in the cloud]((#supported-platforms)).
1116

12-
The documentation for all Stackable products can be found at <https://docs.stackable.tech>.
17+
## Installation
18+
19+
You can install the operator using [stackablectl or helm](https://docs.stackable.tech/spark-k8s/stable/getting_started/installation.html).
20+
21+
Read on to get started with it, or see it in action in one of our [demos](https://stackable.tech/en/demos/).
22+
23+
## Getting Started
24+
25+
You can follow this [tutorial](https://docs.stackable.tech/spark-k8s/stable/getting_started/first_steps.html).
26+
27+
## Documentation
28+
29+
The stable documentation for this operator can be found [here](https://docs.stackable.tech/spark-k8s/stable/index.html).
30+
If you are interested in the most recent state of this repository, check out the [nightly docs](https://docs.stackable.tech/spark-k8s/nightly/index.html) instead.
31+
32+
The documentation for all Stackable products can be found at [docs.stackable.tech](https://docs.stackable.tech).
33+
34+
35+
## About The Stackable Data Platform
36+
37+
This operator is written and maintained by [Stackable](https://www.stackable.tech) and it is part of a larger data platform.
38+
39+
![Stackable Data Platform Overview](./.readme/static/borrowed/sdp_overview.png)
40+
41+
Stackable makes it easy to operate data applications in any Kubernetes cluster.
42+
43+
The data platform offers many operators, new ones being added continuously. All our operators are designed and built to be easily interconnected and to be consistent to work with.
44+
45+
The [Stackable GmbH](https://stackable.tech/) is the company behind the Stackable Data Platform. Offering professional services, paid support plans and custom development.
46+
47+
We love open-source!
48+
49+
## Supported Platforms
50+
51+
We develop and test our operators on the following cloud platforms:
52+
53+
* Kubernetes 1.21-1.24
54+
* EKS on Amazon Web Services (AWS)
55+
* GKE on Google Cloud Platform (GCP)
56+
* AKS on Microsoft Azure
57+
* K3s
58+
59+
We are currently working to support:
60+
61+
* OpenShift
62+
63+
## Other Operators
64+
65+
These are the operators that are currently part of the Stackable Data Platform:
66+
67+
- [Stackable Operator for Apache Airflow](https://github.com/stackabletech/airflow-operator)
68+
- [Stackable Operator for Apache Druid](https://github.com/stackabletech/druid-operator)
69+
- [Stackable Operator for Apache HBase](https://github.com/stackabletech/hbase-operator)
70+
- [Stackable Operator for Apache Hadoop HDFS](https://github.com/stackabletech/hdfs-operator)
71+
- [Stackable Operator for Apache Hive](https://github.com/stackabletech/hive-operator)
72+
- [Stackable Operator for Apache Kafka](https://github.com/stackabletech/kafka-operator)
73+
- [Stackable Operator for Apache NiFi](https://github.com/stackabletech/nifi-operator)
74+
- [Stackable Operator for Apache Spark](https://github.com/stackabletech/spark-k8s-operator)
75+
- [Stackable Operator for Apache Superset](https://github.com/stackabletech/superset-operator)
76+
- [Stackable Operator for Trino](https://github.com/stackabletech/trino-operator)
77+
- [Stackable Operator for Apache ZooKeeper](https://github.com/stackabletech/zookeeper-operator)
78+
79+
And our internal operators:
80+
81+
- [Commons Operator](https://github.com/stackabletech/commons-operator)
82+
- [Listener Operator](https://github.com/stackabletech/listener-operator)
83+
- [OpenPolicyAgent Operator](https://github.com/stackabletech/opa-operator)
84+
- [Secret Operator](https://github.com/stackabletech/secret-operator)
85+
86+
## Contributing
87+
88+
Contributions are welcome. Follow our [Contributors Guide](https://docs.stackable.tech/home/stable/contributor/index.html) to learn how you can contribute.
89+
90+
## License
91+
92+
[Open Software License version 3.0](./LICENSE).
93+
94+
## Support
95+
96+
You can use this project under different licenses. Get started with the community edition! If you want professional support, [we offer subscription plans](https://stackable.tech/en/plans/).

‎deny.toml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,7 @@ allow = [
3333
"Unicode-DFS-2016",
3434
"Zlib"
3535
]
36-
37-
exceptions = [
38-
{ name = "stackable-spark-k8s-crd", allow = ["OSL-3.0"] },
39-
{ name = "stackable-spark-k8s-operator", allow = ["OSL-3.0"] },
40-
{ name = "stackable-spark-k8s-operator-binary", allow = ["OSL-3.0"] },
41-
]
36+
private = { ignore = true }
4237

4338
[[licenses.clarify]]
4439
name = "ring"

‎rust/crd/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ license = "OSL-3.0"
66
name = "stackable-spark-k8s-crd"
77
repository = "https://github.com/stackabletech/spark-k8s-operator"
88
version = "0.6.0-nightly"
9+
publish = false
910

1011
[dependencies]
1112
stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag="0.22.0" }

‎rust/operator-binary/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ license = "OSL-3.0"
66
name = "stackable-spark-k8s-operator"
77
repository = "https://github.com/stackabletech/spark-k8s-operator"
88
version = "0.6.0-nightly"
9+
publish = false
910

1011
[dependencies]
1112
stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag="0.22.0" }

0 commit comments

Comments
 (0)