Skip to content

Commit 94d9159

Browse files
committed
chore: Run operator-templating
Note: Done locally using test.sh
1 parent 21f17f0 commit 94d9159

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+2624
-2
lines changed

.dockerignore

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
debug/
2+
target/
3+
**/*.rs.bk
4+
5+
.idea/
6+
*.iws
7+
8+
Cargo.nix
9+
crate-hashes.json
10+
result
11+
image.tar
12+
13+
# We do NOT want to ignore .git because we use the `built` crate to gather the current git commit hash at built time
14+
# This means we need the .git directory in our Docker image, it will be thrown away and won't be included in the final image

.envrc.sample

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# vim: syntax=conf
2+
#
3+
# If you use direnv, you can autoload the nix shell:
4+
# You will need to allow the directory the first time.
5+
use nix

.gitattributes

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
nix/** linguist-generated
2+
Cargo.nix linguist-generated
3+
crate-hashes.json linguist-generated
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Normal issue
3+
about: This is just a normal empty issue with a simple checklist
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Issue checklist
11+
12+
This is a simple checklist of things to bear in mind when creating a new issue.
13+
14+
- [ ] **Describe the use-case**: As far as possible, use the pattern "As a [type of user], I would like [feature/functionality] to be able to do [specific action]." This helps identify the feature and the problem it addresses.
15+
- [ ] **Indicate importance and urgency**: Use a scale (e.g., low, medium, high) to indicate the level of importance and urgency.
16+
- [ ] **Work-around**: If there is a known work-around, describe it briefly.
17+
- [ ] **Environment**: Describe the environment where the issue occurs (e.g., SDP version, K8S version, etc.).
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: "🐛 Bug Report"
3+
description: "If something isn't working as expected 🤔."
4+
labels: ["type/bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
9+
10+
- type: input
11+
attributes:
12+
label: Affected Stackable version
13+
description: Which version of the Stackable Operator do you see this bug in?
14+
15+
# - type: input
16+
attributes:
17+
label: Affected OpenSearch version
18+
description: Which version of OpenSearch do you see this bug in?
19+
#
20+
- type: textarea
21+
attributes:
22+
label: Current and expected behavior
23+
description: A clear and concise description of what the operator is doing and what you would expect.
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
attributes:
29+
label: Possible solution
30+
description: "If you have suggestions on a fix for the bug."
31+
32+
- type: textarea
33+
attributes:
34+
label: Additional context
35+
description: "Add any other context about the problem here. Or a screenshot if applicable."
36+
37+
- type: textarea
38+
attributes:
39+
label: Environment
40+
description: |
41+
What type of kubernetes cluster you are running aginst (k3s/eks/aks/gke/other) and any other information about your environment?
42+
placeholder: |
43+
Examples:
44+
Output of `kubectl version --short`
45+
46+
- type: dropdown
47+
attributes:
48+
label: Would you like to work on fixing this bug?
49+
description: |
50+
**NOTE**: Let us know if you would like to submit a PR for this. We are more than happy to help you through the process.
51+
options:
52+
- "yes"
53+
- "no"
54+
- "maybe"

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
blank_issues_enabled: true
3+
contact_links:
4+
- name: 🙋🏾 Question
5+
about: Use this to ask a question about this project
6+
url: https://github.com/orgs/stackabletech/discussions/new?category=q-a
7+
- name: 🚀 Feature Requests and other things
8+
about: Open an issue with your feature request or any other issue not covered elsewhere
9+
url: https://github.com/stackabletech/opensearch-operator/issues/new
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Check and Update Getting Started Script
2+
3+
<!--
4+
Make sure to update the link in 'issues/.github/ISSUE_TEMPLATE/pre-release-getting-started-scripts.md'
5+
when you rename this file.
6+
-->
7+
8+
<!--
9+
Replace 'TRACKING_ISSUE' with the applicable release tracking issue number.
10+
-->
11+
12+
Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
13+
14+
> [!NOTE]
15+
> During a Stackable release we need to check (and optionally update) the
16+
> getting-started scripts to ensure they still work after product and operator
17+
> updates.
18+
19+
```shell
20+
# Some of the scripts are in a code/ subdirectory
21+
# pushd docs/modules/superset/examples/getting_started
22+
# pushd docs/modules/superset/examples/getting_started/code
23+
pushd $(fd -td getting_started | grep examples); cd code 2>/dev/null || true
24+
25+
# Make a fresh cluster (~12 seconds)
26+
kind delete cluster && kind create cluster
27+
./getting_started.sh stackablectl
28+
29+
# Make a fresh cluster (~12 seconds)
30+
kind delete cluster && kind create cluster
31+
./getting_started.sh helm
32+
33+
popd
34+
```
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## Bump Rust Dependencies for Stackable Release YY.M.X
2+
3+
<!--
4+
Make sure to update the link in 'issues/.github/ISSUE_TEMPLATE/pre-release-operator-rust-deps.md'
5+
when you rename this file.
6+
-->
7+
8+
<!--
9+
Replace 'TRACKING_ISSUE' with the applicable release tracking issue number.
10+
-->
11+
12+
Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
13+
14+
> [!NOTE]
15+
> During a Stackable release we need to update various Rust dependencies before
16+
> entering the final release period to ensure we run the latest versions of
17+
> crates. These bumps also include previously updated and released crates from
18+
> the `operator-rs` repository.
19+
20+
### Tasks
21+
22+
- [ ] Bump Rust Dependencies, see below for more details.
23+
- [ ] Add changelog entry stating which important crates were bumped (including the version).
24+
25+
> [!NOTE]
26+
> The bumping / updating of Rust dependencies is done in multiple steps:
27+
>
28+
> 1. Update the minimum Version in the root `Cargo.toml` manifest.
29+
> 2. Run the `cargo update` command, which also updates the `Cargo.lock` file.
30+
> 3. Lastly, run `make regenerate-nix` to update the `Cargo.nix` file.
31+
32+
### Bump Rust Dependencies
33+
34+
- [ ] Bump `stackable-operator` and friends
35+
- [ ] Bump `product-config`
36+
- [ ] Bump all other dependencies

.github/actionlint.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
self-hosted-runner:
3+
# Ubicloud machines we are using
4+
labels:
5+
- ubicloud-standard-8-arm

.github/pull_request_template.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Description
2+
3+
*Please add a description here. This will become the commit message of the merge request later.*
4+
5+
## Definition of Done Checklist
6+
7+
- Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
8+
- Please make sure all these things are done and tick the boxes
9+
10+
### Author
11+
12+
- [ ] Changes are OpenShift compatible
13+
- [ ] CRD changes approved
14+
- [ ] CRD documentation for all fields, following the [style guide](https://docs.stackable.tech/home/nightly/contributor/docs/style-guide).
15+
- [ ] Helm chart can be installed and deployed operator works
16+
- [ ] Integration tests passed (for non trivial changes)
17+
- [ ] Changes need to be "offline" compatible
18+
19+
### Reviewer
20+
21+
- [ ] Code contains useful comments
22+
- [ ] Code contains useful logging statements
23+
- [ ] (Integration-)Test cases added
24+
- [ ] Documentation added or updated. Follows the [style guide](https://docs.stackable.tech/home/nightly/contributor/docs/style-guide).
25+
- [ ] Changelog updated
26+
- [ ] Cargo.toml only contains references to git tags (not specific commits or branches)
27+
28+
### Acceptance
29+
30+
- [ ] Feature Tracker has been updated
31+
- [ ] Proper release label has been added
32+
- [ ] [Roadmap](https://github.com/orgs/stackabletech/projects/25/views/1) has been updated

0 commit comments

Comments
 (0)