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

[CADC-13697] Science Platform CI/CD Updates #697

Open
wants to merge 51 commits into
base: main
Choose a base branch
from

Conversation

shinybrar
Copy link
Collaborator

@shinybrar shinybrar commented Oct 1, 2024

Changes

  • helm: added a new helm chart for dev ivoa dev registry
  • helm: added new base template to provision a developer storage
  • helm: added placeholder helm tests which can be run via helm test base, this is currently a work-in-progress.
  • CI/CD: Implemented basic CI through Github Actions, more to come soon.
  • CI/CD: Implemented conventional commit standards, both via .pre-commit-config.yaml and also a separate commit message check in Github Actions
  • CI/CD: With this PR, we also plan to integrate / test how github action changes will be propagated and introduced from forks.
  • base: updated base chart values to better reflect possible configurations via dev.overrides and added docs
  • helm: Added docs made via helm-docs in the base template, with the goal to have updated/auto-generated all docs for helm charts. This feature uses the README.md.gotpl file as a documentation slug.
  • helm: Added support for NOTES.txt file, which makes all the post-installation checks and documentation print in the terminal after a helm install.
  • linting: Cleaned up end-of-file newline changes via pre-commit.

shinybrar and others added 27 commits September 24, 2024 10:04
…he project

README is now auto-generated usign helm-docs, which in turn uses README.md.gotpl as the template to populate all the update-to-date values from values.yml
…es are provided for the secrets, i.e. null and empty secret values do not result in the creation of a kubernetes secret
…configurations via dev.overrides and added docs
…, also added placeholder helm tests which can be run via `helm test base`

helm tests are currently a work-in-progress
…ces, updated readme with special dev instructions
deployment/helm/README.md Show resolved Hide resolved
deployment/helm/base/README.md Outdated Show resolved Hide resolved
deployment/helm/base/README.md Outdated Show resolved Hide resolved
deployment/helm/base/README.md.gotmpl Outdated Show resolved Hide resolved
deployment/helm/base/dev.overrides.yaml Outdated Show resolved Hide resolved
deployment/helm/posix-mapper/values.yaml Outdated Show resolved Hide resolved
deployment/helm/posix-mapper/values.yaml Outdated Show resolved Hide resolved
deployment/helm/posix-mapper/values.yaml Outdated Show resolved Hide resolved
deployment/helm/registry/Chart.yaml Show resolved Hide resolved
deployment/helm/registry/README.md Show resolved Hide resolved
@shinybrar
Copy link
Collaborator Author

@at88mph

All changes requested in the PR, except the one commented above have been made.

Additionally,

  • Fixed base tests, which run successfully now with required service account fixtures being deleted after tests are completed by helm itself, see here. The main addition is annotations for helm.sh/[hook-delete-policy|hook-weight] which describe the order in which the test actions take place, and the final cleanup at the end.
  • Added CI, where I setup a K8S cluster, install helm, install the base chart and then run the tests as well, see the run logs here and the source code here.
  • Added checks in pre-commit check for helm-docs to be kept up-to-date. For now, this is only enabled for base and registry charts.
  • Performed all of the end-of-file-fixes and trailing-whitespace fixes for the entire repository to pass lint checks. These will be only sources of merge-conflicts.
  • Enabled the filesystem config block for cavern, since its required in the current implementation and thus needed to build a template.

Questions

  • Should we fail CI/CD if helm docs are not up-to-date or auto generate them based on the README.md.gotpl and values.yml and perform a bot commit to pass the CI/CD

@shinybrar shinybrar marked this pull request as ready for review October 9, 2024 00:29
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.

2 participants