arhat.dev/helm-stack@v0.1.2/README.md (about)

     1  # helm-stack
     2  
     3  [![CI](https://github.com/arhat-dev/helm-stack/workflows/CI/badge.svg)](https://github.com/arhat-dev/helm-stack/actions?query=workflow%3ACI)
     4  [![Build](https://github.com/arhat-dev/helm-stack/workflows/Build/badge.svg)](https://github.com/arhat-dev/helm-stack/actions?query=workflow%3ABuild)
     5  [![PkgGoDev](https://pkg.go.dev/badge/arhat.dev/helm-stack)](https://pkg.go.dev/arhat.dev/helm-stack)
     6  [![GoReportCard](https://goreportcard.com/badge/arhat.dev/helm-stack)](https://goreportcard.com/report/arhat.dev/helm-stack)
     7  [![codecov](https://codecov.io/gh/arhat-dev/helm-stack/branch/master/graph/badge.svg)](https://codecov.io/gh/arhat-dev/helm-stack)
     8  
     9  Stack your cluster deployments the easy way
    10  
    11  ## Config
    12  
    13  All configration files provided to helm-stack will be merged, please make sure there are no duplicate items in your configuration files
    14  
    15  - For file based config: Please refer to [`.helm-stack.yaml`](./.helm-stack.yaml) for example
    16  - For directory based config: Please refer to [`.helm-stack`](./.helm-stack) for example
    17  
    18  **NOTE:** helm-stack by default will try to read configuration files in `.helm-stack` and `helm-stack.yaml`, but if you have provided any `-c` or `--config` flag, helm-stack will not use these default config files.
    19  
    20  ## Workflow
    21  
    22  __TL;DR:__ [`template-kubernetes-cluster`](https://github.com/arhat-dev/template-kubernetes-cluster) contains a complete cluster management workflow
    23  
    24  1. Define your charts and deployment environments in a yaml/json config file or using multiple yaml/json config files (in the same parent directory)
    25  2. Run `helm-stack ensure` to ensure charts and values files
    26  3. Update yaml values files in `<environments-dir>/<environment-name>` according to your deployments requirements
    27  4. After several updates, there may be some charts unused, you can remove these charts and related values file with `helm-stack clean`
    28  5. Run `helm-stack gen` to generate kubernetes manifests
    29  6. Run `helm-stack apply` to deploy manifests to your environment
    30  
    31  Please refer to [`.helm-stack`](./.helm-stack/) for config structure
    32  
    33  ## Build
    34  
    35  ```bash
    36  make helm-stack
    37  ```
    38  
    39  ## Install
    40  
    41  Install helm-stack to `${GOPATH}/bin/helm-stack`
    42  
    43  ```bash
    44  GOOS=$(go env GOHOSTOS) GOARCH=$(go env GOHOSTARCH) go install ./cmd/helm-stack
    45  ```
    46  
    47  ## LICENSE
    48  
    49  ```text
    50  Copyright 2020 The arhat.dev Authors.
    51  
    52  Licensed under the Apache License, Version 2.0 (the "License");
    53  you may not use this file except in compliance with the License.
    54  You may obtain a copy of the License at
    55  
    56      http://www.apache.org/licenses/LICENSE-2.0
    57  
    58  Unless required by applicable law or agreed to in writing, software
    59  distributed under the License is distributed on an "AS IS" BASIS,
    60  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    61  See the License for the specific language governing permissions and
    62  limitations under the License.
    63  ```