Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maria-reynoso committed Oct 16, 2024
1 parent bb1ed1e commit 2f2b6d4
Showing 1 changed file with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions installation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,35 @@ This documentation provides instructions for installing the FinOps Stack in Kind

## Pre-requisites

- A [Kind](https://kind.sigs.k8s.io/) cluster
- kubectl
- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) installed on your local machine
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
- [Helmfile](https://helmfile.readthedocs.io/en/latest/#installation) installed on your local machine

## Distribution support
## Installation

- Custom pricing to be applied by updating OpenCost Helm values file
## Create a kind cluster

## Installation
```bash
make cluster
```

### Configuration changes for your cluster environment

1. To control which Finops Stack components to install, edit the [enabled.yaml](./installation/config/common/enabled.yaml) file
1. Copy `./env.tmpl` to `./.env` and replace the env var values accordingly. As a minimum, you will need to change the `GCP_PROJECT`, `CSP_API_KEY`, `GRAFANA_SA_ANNOTATION` values. <!-- TODO: Automate env variable values replacement -->
1. Copy env.tmpl file and replace the env var values accordingly (`GRAFANA_FQDN` for example).

```sh
cp ./env.tmpl ./.env
```

### Install everything using Helmfile

For the first run:

```bash
set -a; source .env; set +a; helmfile apply --file helmfile_kind.yaml --interactive
make finops-stack
# FinOps stack is install using Helmfile:
# set -a; source .env; set +a; helmfile apply --file helmfile_kind.yaml --interactive
```

NOTE: it will take several minutes for all workloads to install and start running. Helmfile does display its progress in the terminal. All workloads get installed into the `finops-stack` namespace so you can also view progress using `kubectl`.
Expand All @@ -53,8 +61,11 @@ General guidance when configuring ingress:

## Enable Goldilocks for namespaces

For Goldilocks to analyse namespaces and add then to its dashboard you need to add this label to the namespace resource: `goldilocks.fairwinds.com/enabled=true`, e.g.
`kubectl label ns finops-stack goldilocks.fairwinds.com/enabled=true`
For Goldilocks to analyse namespaces and add then to its dashboard you need to add this label to the namespace resource: `goldilocks.fairwinds.com/enabled=true`, e.g:

```bash
kubectl label ns finops-stack goldilocks.fairwinds.com/enabled=true
```

## Useful commands

Expand Down

0 comments on commit 2f2b6d4

Please sign in to comment.