# captain

**Repository Path**: coolcore2022/captain

## Basic Information

- **Project Name**: captain
- **Description**: Captain is a Helm 3 Controller
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-09-21
- **Last Updated**: 2022-09-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![](./logo.png)
# Captain

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Go Report Card](https://goreportcard.com/badge/github.com/alauda/captain)](https://goreportcard.com/report/github.com/alauda/captain) [![Tag](https://img.shields.io/github/tag/alauda/captain)](https://img.shields.io/github/tag/alauda/captain)
![Docker Image CI](https://github.com/alauda/captain/workflows/Docker%20Image%20CI/badge.svg)
![Go](https://github.com/alauda/captain/workflows/Go/badge.svg)

Captain is a Helm 3 Controller


![](./docs/imgs/captain-arc-2.png)


## About Helm3 

This project is based on the core [helm](https://github.com/helm/helm) v3 code, acting as a library. Some modifications were made to help implement this controller on a fork: [alauda/helm](https://github.com/alauda/helm) .

## Features
* HelmRequest/ChartRepo/Release CRD, namespace based
* Git/Svn as ChartRepo
* Local ChartRepo based on ChartMuseum
* Multi cluster support based on [cluster-registry](https://github.com/kubernetes/cluster-registry)
* Dependency check for HelmRequest (between HelmRequests)
* `valuesFrom` support: support to ConfigMap or Secret value store
* `kubectl apply` like resource manipulation: no more resource conflict and CRD management issues
* OCI chart support
* HTTP downloadable chart support


## Quick Start
Check the [Installation Guide](./docs/en/install.md) to learn how to install captain

Then, create a HelmRequest resource 

```yaml
kind: HelmRequest
apiVersion: app.alauda.io/v1
metadata:
  name: nginx-ingress
spec:
  chart: stable/nginx-ingress
```
After a few seconds, you have an nginx-ingress chart running

```bash
root@VM-16-12-ubuntu:~/demo# kubectl get pods
NAME                                             READY   STATUS    RESTARTS   AGE
nginx-ingress-controller-57987f445c-9rhv5        1/1     Running   0          16s
nginx-ingress-default-backend-7679dbd5c9-wkkss   1/1     Running   0          16s
root@VM-16-12-ubuntu:~/demo# kubectl get hr
NAME            CHART                  VERSION   NAMESPACE   ALLCLUSTER   PHASE    AGE
nginx-ingress   stable/nginx-ingress             default                  Synced   23s
```

For the detailed explain and advanced usage, please check the documentation below



## Documention

* [How captain works](./docs/en/captain.md)
* [Captain Upgrade](./docs/en/upgrade.md)
* [CRDs explain](./docs/en/crd.md)
* [Multi-Cluster Support](./docs/en/multi-cluster.md)
* [Git/SVN as ChartRepo](./docs/en/vcs-repo.md)
* [Annotations](./docs/en/ano.md)
* [OCI Support](./docs/en/crds/helmrequest.md#helmrequest-oci-support)
* [ARM64 Support](./docs/en/arm64.md)
* [FAQ](./docs/en/faq.md)

## SDK
* [Golang](https://github.com/alauda/helm-crds): also contains the CRD definition

## Future Plans
* Java SDK
* Auto update of HelmRequest
* Always update to the latest version of chart


## Captain Releated Projects
* [kubectl-captain](https://github.com/alauda/kubectl-captain): a kubectl plugin for captain
* [captain-test-charts](https://github.com/alauda/captain-test-charts): test charts for captain
* [oci-chartrepo](https://github.com/alauda/oci-chartrepo): use oci registry as helm chart repo

## Related Projects

* [flux](https://github.com/fluxcd/flux): flux have a similar controller based on Helm2