Code Monkey home page Code Monkey logo

cgici-charts's Introduction

CGI Space Helm Charts

This repository is a collection of Helm Charts for shared use in CGI Space Kubernetes environments.

Usage

To package the Charts and generate repository metadata, use the build_repo.sh script. This will generate a Helm repository in the docs directory, which is exposed via GitHub Pages (ref: Helm docs). Soon after the master branch is updated, the Helm repo will reflect the changes.

When adding a new Chart, prefer in this order:

  • Importing an existing Chart without modifications (e.g. from the official repo)
  • Adapting or modifying an existing Chart
  • Importing and templating a set of existing Kubernetes manifests
  • Creating a Chart from scratch

General packaging best practices should be followed:

  • Provide comments/docs to guide users
  • Bump Chart version and appVersion numbers appropriately when updating
  • Avoid hard-coding values, in favour of the standard Helm Values and template functionality

After adding a new Chart, update the CHARTS.md file with provenance and notes, and add it to the PACKAGES variable in build_repo.sh.

Remember to re-run build_repo.sh after adding or modifying any Chart.

Custom container images

If no appropriate container image exists in a public registry, provide an images directory in the Chart, containing the source required to build the necessary images. Build and deployment actions should be set up for all such images before the Chart can be used in a cluster.

Future work / in-progress

  • CI integration to build and publish Helm repo without GitHub Pages

cgici-charts's People

Contributors

zetten avatar

Watchers

 avatar James Cloos avatar Eli Treuherz avatar AdrianR avatar

Forkers

jpbower treuherz

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.