Skip to content
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.

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

feat: Upload helm chart for Steampipe #1

Merged
merged 1 commit into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
88 changes: 88 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
name: Bug report
description: Create a bug report
title: "[steampipe] Bug title"
labels: [bug]
body:
- type: markdown
attributes:
value: Please be cautious with the sensitive information/logs while filing the issue.

- type: textarea
id: description
attributes:
label: Describe the bug a clear and concise description of what the bug is.
validations:
required: true

- type: input
id: helm-version
attributes:
label: What's your helm version?
description: Output of `#~ helm version`
validations:
required: true

- type: input
id: kubectl-version
attributes:
label: What's your kubectl version?
description: Output of `#~ kubectl version`
validations:
required: true

- type: input
id: chart-version
attributes:
label: Chart version
description: Enter the version of the chart that you encountered this bug.
validations:
required: true

- type: textarea
id: explain-bug
attributes:
label: Explain bug
description: Explain what happened.
validations:
required: false

- type: textarea
id: expected-result
attributes:
label: What you expected to happen?
description: Enter what you expected to happen.
validations:
required: false

- type: textarea
id: reproduce-bug
attributes:
label: How to reproduce it?
description: Explain step-by-step if is possible.
validations:
required: false

- type: textarea
id: chart-values
attributes:
label: Enter the changed values of values.yaml?
description: Please enter only values which differ from the defaults. Enter `NONE` if nothing's changed.
placeholder: "key: value"
validations:
required: false

- type: textarea
id: helm-command
attributes:
label: Enter the command that you execute when chart failing/misfunctioning
description: Enter the command as-is as how you executed.
placeholder: helm install [RELEASE] steampipe/steampipe --version [VERSION] -f values.yaml --debug
validations:
required: true

- type: textarea
id: more-info
attributes:
label: More info
validations:
required: false
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Feature request
description: Suggest an idea to improve this project
title: "[steampipe] Feature title"
labels: [enhancement]
body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this bug report!

- type: textarea
id: description
attributes:
label: Is your feature request related to a problem?
description: Description of what the problem is.
validations:
required: true

- type: textarea
id: proposals
attributes:
label: Describe the solution you'd like
description: Description of what you want to happen.
validations:
required: true

- type: textarea
id: improves
attributes:
label: Describe alternatives you've considered
description: Description of any alternative solutions or features you've considered. If nothing, please enter `NONE`
validations:
required: true

- type: textarea
id: more-info
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
32 changes: 32 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!--
Before you submit this PR we'd like to make sure you are aware of our technical requirements and best practices:

* https://github.com/devops-ia/helm-steampipe/blob/main/CONTRIBUTING.md#technical-requirements
* https://helm.sh/docs/chart_best_practices/

Following our best practices right from the start will accelerate the review process and help get your PR merged quicker.

When updates to your PR are requested, please add new commits and do not squash the history.
This will make it easier to identify new changes. The PR will be squashed anyways when it is merged.

For fast feedback, please @-mention maintainers that are listed in the Chart.yaml file.

PR Steps:
1) Please make sure you test your changes before you push them.
2) Once pushed, GitHub Actions will run across your changes and do some initial checks and linting.
3) These checks run very quickly.
4) Please check the results.
5) We would like these checks to pass before we even continue reviewing your changes.
-->
#### What this PR does / why we need it:

#### Which issue this PR fixes
*(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*
- fixes #

#### Special notes for your reviewer:

#### Checklist
<!-- [Place an '[x]' (no spaces) in all applicable fields. Please remove unrelated fields.] -->
- [ ] [DCO](https://github.com/devops-ia/helm-steampipe/blob/main/CONTRIBUTING.md#sign-off-your-work) signed
- [ ] Chart version bumped
10 changes: 10 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: "/"
schedule:
interval: monthly
open-pull-requests-limit: 10
labels:
- enhancement
- dependency-management
20 changes: 20 additions & 0 deletions .github/workflows/auto-assign.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Auto assign
on:
issues:
types: [opened, edited, synchronize, reopened]
pull_request:
types: [opened, edited, synchronize, reopened]
jobs:
run:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write

steps:
- name: "Auto-assign issue"
uses: pozil/auto-assign-issue@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
assignees: amartingarcia
numOfAssignee: 1
31 changes: 31 additions & 0 deletions .github/workflows/lint-test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Lint and Test Charts

on: pull_request

jobs:
lint-test:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Set up Helm
uses: azure/setup-helm@v4
with:
version: v3.13.0

- uses: actions/setup-python@v5
with:
python-version: 3.x
check-latest: true

- name: Set up chart-testing
uses: helm/chart-testing-action@v2

- name: Create kind cluster
uses: helm/kind-action@v1

- name: Run chart-testing (lint-and-install)
run: ct lint-and-install --config ct.yaml
38 changes: 38 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Release charts
on:
push:
branches:
- main
jobs:
release:
runs-on: ubuntu-latest
steps:
- name: Checkout Code
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Configure Git
run: |
git config user.name "$GITHUB_ACTOR"
git config user.email "$GITHUB_ACTOR@users.noreply.github.com"

- name: Set up Helm
uses: azure/setup-helm@v4
with:
version: v3.13.0

# - name: Add repositories
# run: |
# for dir in $(ls -d charts/); do
# helm dependency list $dir 2> /dev/null | tail +2 | head -n -1 | awk '{ print "helm repo add " $1 " " $3 }' | while read cmd; do $cmd; done
# done

- name: Run chart-releaser
uses: helm/chart-releaser-action@v1.6.0
with:
#charts_dir: ./
config: cr.yaml
env:
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
CR_SKIP_EXISTING: true
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*.tgz
Chart.lock
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# How to contribute to Steampipe Helm Chart

This document provides guidelines for contributing to the *Steampipe Helm Chart* project.

## How can I contribute?

### Did you find a bug?

* **Ensure the bug has not already been reported** by searching on GitHub under [Issues](https://github.com/devops-ia/helm-steampipe/issues).
* If you cannot find an open issue addressing the problem, [open a new one](https://github.com/devops-ia/helm-steampipe/issues/new). Include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the unexpected behavior.
* Use the relevant bug report templates to create the issue, if available.

### Do you intend to add a new feature or change an existing one?

* Please discuss first ([open an issue](https://github.com/devops-ia/helm-steampipe/issues)) before starting any significant pull request (e.g., implementing features, refactoring code) to avoid spending time on something that might not be merged.
* Adhere to the project's coding conventions (indentation, accurate comments, etc.) and any other requirements (such as test coverage, documentation).

## Styleguides

### YAML Styleguide

All YAML files must adhere to the following style guide:

* Indentation: Use 2 spaces for indentation.
* No trailing spaces.
* Use hyphens for list items.
* Use camelCase for key names.
* Ensure there are no syntax errors.

Additional rules:

* Always use double quotes for strings.
* Keep lines to a maximum of 80 characters.
* Ensure proper alignment of nested elements.

### Git Commit Messages

* Use the present tense ("Add feature" not "Added feature").
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
* Limit the first line to 72 characters or less.
* Reference issues and pull requests liberally after the first line.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,28 @@
# helm-steampipe
Helm chart for Steampipe
# Steampipe Helm Chart

[Steampipe](https://steampipe.io/) is the zero-ETL solution for getting data directly from APIs and services. We offer these Steampipe engines.

## Usage

Charts are available in:

* [Chart Repository](https://helm.sh/docs/topics/chart_repository/)

### Chart Repository

#### Add repository

```console
helm repo add steampipe https://devops-ia.github.io/helm-steampipe
helm repo update
```

#### Install Helm chart

```console
helm install [RELEASE_NAME] steampipe/steampipe
```

This install all the Kubernetes components associated with the chart and creates the release.

_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
23 changes: 23 additions & 0 deletions charts/.helmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*.orig
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
18 changes: 18 additions & 0 deletions charts/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
apiVersion: v2
name: steampipe
description: A Helm chart for Kubernetes to deploy Steampipe
type: application
version: 1.7.0
appVersion: "0.22.0"
home: https://github.com/devops-ia/helm-steampipe
sources:
- https://github.com/turbot/steampipe
maintainers:
- name: devops-ia
url: https://github.com/devops-ia

dependencies:
- name: oauth2-proxy
version: "7.7.9"
repository: https://oauth2-proxy.github.io/manifests/
condition: oauth2Proxy.enabled
Loading