# charts

**Repository Path**: yangfanimb/charts

## Basic Information

- **Project Name**: charts
- **Description**: kubernetes helm charts
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: https://ygqygq2.github.io/charts/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2020-09-21
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ygqygq2 Helm Charts

[![Build Status](https://travis-ci.org/ygqygq2/charts.svg?branch=master)](https://travis-ci.org/ygqygq2/charts)

This repository hosts the official **ygqygq2 Helm Charts** to deploy **ygqygq2** products to [Kubernetes](https://kubernetes.io/)

## Install Helm

Get the latest [Helm release](https://github.com/kubernetes/helm#install).

## Install Charts

You need to add this Chart repo to Helm:

```console
helm repo add ygqygq2 https://ygqygq2.github.io/charts/
helm repo update
```

**Note:** For instructions on how to install a chart follow instructions in its _README.md_.

## Contributing to ygqygq2 Charts

Fork the `repo`, make changes and then please run `make lint` to lint charts locally, and at last install the chart to see it is working. :)

On success make a [pull request](https://help.github.com/articles/using-pull-requests) (PR).

Upon successful review, someone will give the PR a __LGTM__ (_looks good to me_) in the review thread.
Two __LGTM__ are needed to get the PR approved and merged.

## Linting charts locally

**Note:** Docker must be running on your Mac/Linux machine. 
The command will only lint changed charts.

To lint all charts:

```console
make lint
```

### Forcing to lint unchanged charts

**Note:** Chart version bump check will be ignored.

You can force to lint one chart with `--charts` flag:

```console
make lint -- --charts ygqygq2/elastichd
```

You can force to lint a list of charts (separated by comma) with `--charts` flag:

```console
make lint -- --charts ygqygq2/elastichd,ygqygq2/nginx-php
```

You can force to lint all charts with `--all` flag:

```console
make lint -- --all
```

## Manually testing charts with Docker for Mac Kubernetes Cluster

**Note:** Make sure **'Show system containers (advanced)'** is enabled in `Preferences/Kubernetes`.

On the Mac you can install and test all changed charts in `Docker for Mac`:

```console
make mac
```

### Forcing to install unchanged charts

You can force to install one chart with `--charts` flag:

```console
make mac -- --charts ygqygq2/elastichd
```

You can force to install a list of charts (separated by comma) with `--charts` flag:

```console
make mac -- --charts ygqygq2/elastichd,ygqygq2/nginx-php
```

You can force to install all charts with `--all` flag:

```console
make mac -- --all
```

**Note:** It might take a while to run install test for all charts in `Docker for Mac`.

## Manually testing charts with Docker and KinD

**Note:** [kind cli](https://github.com/kubernetes-sigs/kind/) must be installed.

You can install and test all changed charts in Docker with Kind:

```console
make kind
```

### Forcing to install unchanged charts

You can force to install one chart with `--charts` flag:

```console
make kind -- --charts ygqygq2/elastichd
```

You can force to install a list of charts (separated by comma) with `--charts` flag:

```console
make kind -- --charts ygqygq2/elastichd,ygqygq2/nginx-php
```

You can force to install all charts with `--all` flag:

```console
make kind -- --all
```

**Note:** It might take a while to run install test for all charts in Docker with Kind.

## Manually testing charts with remote GKE cluster

You can install and test changed charts with `GKE` cluster set in kubeconfig `context`:

```console
make gke
```

### Forcing to install unchanged charts

You can force to install one chart with `--charts` flag:

```console
make gke -- --charts ygqygq2/elastichd
```

You can force to install a list of charts (separated by comma) with `--charts` flag:

```console
make gke -- --charts ygqygq2/elastichd,ygqygq2/nginx-php
```

You can force to install all charts with `--all` flag:

```console
make gke -- --all
```

### Using dedicated GKE cluster for manual charts testing

By default it uses the `GKE` cluster set in kubeconfig `context`, you can specify the dedicated cluster (it must be set in the kubeconfig) in the file `CLUSTER`:

```
GKE_CLUSTER=gke_my_cluster_context_name
```

Then store the `CLUSTER` file in the root folder of the repo. It is also ignored by git.

In such setup your local default cluster can be different from the charts testing one.


## Docs

For more information on using Helm, refer to the Helm's [documentation](https://docs.helm.sh/using_helm/#quickstart-guide).

To get a quick introduction to Charts see this Chart's [documentation](https://docs.helm.sh/developing_charts/#charts).