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

INCEpTION HelmChart #2

Draft
wants to merge 28 commits into
base: main
Choose a base branch
from

Conversation

kzgrzendek
Copy link

What's in the PR

  • This PR contains a HelmChart allowing INCEpTION's deployment in a cloud-native & vendor-agnostic way

How to test manually

  • Deploy a local K8S cluster using kind with a deployed Ingress Controller
  • You must have Helm 3 installed
  • From the root of the git repo, just run
     helm upgrade --install inception ./chart/inception
  • Once the INCEpTION pod will be ready, you can access the application from http://localhost/

Automatic testing

  • There's no auto-test for Helm, but we can talk about including documentation generation, schema validation and helm linting in the CI

Documentation

  • All the Chart's documentation is inside chart/inception/README.md file
  • That documentation can be re-generated with helm-doc, from the root of the git repo :
    docker run --rm --volume "$(pwd)/chart/inception:/helm-docs" -u $(id -u) jnorwood/helm-docs:latest --sort-values-order=file
  • The values schema file can be re-generated with the Helm values-schema plugin, from the root of the git repo :
    helm schema -input chart/inception/values.yaml
  • If you're OK with the merge request, we can discuss about updating the official INCEpTION documentation regarding the Kubernete's deployment section

PS @reckart : The CLAs are on their way, the holidays are adding a bit of delay. I think it's best not merging this MR until you have them, but I'll happily exchange about the feature until then :)

- Moved the chart from inception forked repo
@kzgrzendek kzgrzendek changed the title [1] - [INCEpTION HelmChart]INCEpTION HelmChart NCEpTION HelmChart Aug 22, 2024
@kzgrzendek kzgrzendek changed the title NCEpTION HelmChart INCEpTION HelmChart Aug 22, 2024
@kzgrzendek kzgrzendek marked this pull request as draft August 22, 2024 14:36
@kzgrzendek
Copy link
Author

TODO :

  • Update INCEpTION's documentation
  • Using gh pages as a chart repository

Kévin ZGRZENDEK and others added 24 commits August 22, 2024 21:33
- Changed directory structure to match the HelmChart Release github action.
- Added github action to release the chart to the gh-page branch.
- Added the feat/helmchart branch to the github release action to test the chart release.
- Init the chart with the correspnding github action
- Added anotation to keep the Data PVC resource after deletion of the release.
- Bumped Chart version to 1.0.0 alpha2
- Used out-of-box Bitnami env vars to set MariaDB character set and collation, rather than overriding the config file
- Bumped Chart version to 1.0.0 alpha3
- Bumped Chart version to 1.0.0 alpha3
 - Added support for oauth2 role mapping feature and existing pvc for the data volume
- Fixed existing data PVC handling
- Fixed existing data PVC handling
- Added support for secrets for the OAuth2 Client ID
- Added support for secret with clientID
- Fixed bad ref to secretKey for database password in INCEpTION's deployment config
- Updated MariaDB Chart's version
- Split jobs between files
- Added dependencies between jobs
- Fixed linting job version
- Updated chart formatting and added maintainers
- Updated chart formatting and added maintainers
Updated github workflow organization
Implemented helm-docs action
Fixed bad checkut action version
Kévin ZGRZENDEK added 3 commits October 11, 2024 16:44
Updtaed checkout axction ti v4 and fixed chart location
Updtaed checkout axction to v4 and fixed chart location
Added Helm Chart values schema update
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant