diff --git a/README.md b/README.md index dee1495..eb45a7f 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ This repository contains the core components of FinOps Stack, including: ## Installation and Usage -For ease of use, the FinOps Stack is installed using a single Helmfile command. For detailed installation instructions, review the README under the `/installation` directory of this repository. +For ease of use, the FinOps Stack is installed using a single Helmfile command. For detailed installation instructions, review the README under the [installation](/installation) directory of this repository. ## Contributing diff --git a/installation/README.md b/installation/README.md index 72727db..34d91b4 100644 --- a/installation/README.md +++ b/installation/README.md @@ -13,7 +13,7 @@ This documentation focuses on installing the FinOps Stack in GKE standard/autopi - [Helmfile](https://helmfile.readthedocs.io/en/latest/#installation) installed on your local machine - A Google Service Account with the following: - roles/monitor.viewer and roles/iam.serviceAccountTokenCreator permissions - - workload identity configured for grafana kubernetes service account: `[finops-stack/grafana]` + - workload identity configured for grafana kubernetes service account: `[finops-stack/grafana]`. Have a look at this [blog post](https://venafi.com/blog/gke-workload-identity-federation-for-kubernetes-principals/) to configure workload identity. - Unless you want to access the Grafana dashboard via `kubectl port-forward` you'll need a domain name ## Distribution support @@ -26,8 +26,8 @@ This documentation focuses on installing the FinOps Stack in GKE standard/autopi ### Configuration changes for your cluster environment -1. To control which Finops Stack components to install, edit the `./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. +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. ### Install everything using Helmfile diff --git a/installation/config/common/cert-manager-values.yaml b/installation/config/common/cert-manager-values.yaml index 65ef899..6c28f6e 100644 --- a/installation/config/common/cert-manager-values.yaml +++ b/installation/config/common/cert-manager-values.yaml @@ -25,4 +25,4 @@ cainjector: memory: 52M limits: cpu: 100m - memory: 103M \ No newline at end of file + memory: 103M diff --git a/installation/config/common/enabled.yaml b/installation/config/common/enabled.yaml index 7cb9f6b..81f356a 100644 --- a/installation/config/common/enabled.yaml +++ b/installation/config/common/enabled.yaml @@ -30,4 +30,4 @@ gmp-proxy: # -- Enable / Disable the installation of Fairwinds' Goldilocks goldilocks: - enabled: true \ No newline at end of file + enabled: true diff --git a/installation/config/common/gmp-proxy-values.yaml b/installation/config/common/gmp-proxy-values.yaml index 2f965da..569fef3 100644 --- a/installation/config/common/gmp-proxy-values.yaml +++ b/installation/config/common/gmp-proxy-values.yaml @@ -4,4 +4,4 @@ resources: memory: 52M limits: cpu: 100m - memory: 103M \ No newline at end of file + memory: 103M diff --git a/installation/config/common/goldilocks-values.yaml b/installation/config/common/goldilocks-values.yaml index 4165ca0..45e2894 100644 --- a/installation/config/common/goldilocks-values.yaml +++ b/installation/config/common/goldilocks-values.yaml @@ -14,4 +14,4 @@ dashboard: memory: 103M requests: cpu: 50m - memory: 52M \ No newline at end of file + memory: 52M diff --git a/installation/config/common/grafana-values.yaml b/installation/config/common/grafana-values.yaml index 56e0f88..682378f 100644 --- a/installation/config/common/grafana-values.yaml +++ b/installation/config/common/grafana-values.yaml @@ -1,24 +1,24 @@ - rbac: - namespaced: true - testFramework: - enabled: false +rbac: + namespaced: true +testFramework: + enabled: false - adminUser: finops - adminPassword: admin123 # pragma: allowlist secret - enableServiceLinks: false - plugins: [] +adminUser: finops +adminPassword: admin123 # pragma: allowlist secret +enableServiceLinks: false +plugins: [] - grafana.ini: - analytics: - check_for_updates: false - sidecar: - dashboards: - enabled: true - labelValue: finops - resources: - limits: - cpu: 500m - memory: 512M - requests: - cpu: 250m - memory: 350M \ No newline at end of file +grafana.ini: + analytics: + check_for_updates: false +sidecar: + dashboards: + enabled: true + labelValue: finops +resources: + limits: + cpu: 500m + memory: 512M + requests: + cpu: 250m + memory: 350M diff --git a/installation/config/common/kyverno-values.yaml b/installation/config/common/kyverno-values.yaml index 812c2ba..db0ca7d 100644 --- a/installation/config/common/kyverno-values.yaml +++ b/installation/config/common/kyverno-values.yaml @@ -2,10 +2,10 @@ reportsController: rbac: clusterRole: extraResources: - - apiGroups: [events.k8s.io] - resources: ["events"] - verbs: [create] + - apiGroups: [events.k8s.io] + resources: ["events"] + verbs: [create] grafana: enabled: true labels: - grafana_dashboard: "finops" \ No newline at end of file + grafana_dashboard: "finops" diff --git a/installation/config/common/vpa-values.yaml b/installation/config/common/vpa-values.yaml index a23c3be..948c1a7 100644 --- a/installation/config/common/vpa-values.yaml +++ b/installation/config/common/vpa-values.yaml @@ -1,17 +1,9 @@ updater: - resources: - { - "limits": { "cpu": "50m", "memory": "75Mi" }, - "requests": { "cpu": "50m", "memory": "52Mi" }, - } + resources: {"limits": {"cpu": "50m", "memory": "75Mi"}, "requests": {"cpu": "50m", "memory": "52Mi"}} recommender: - resources: - { - "limits": { "cpu": "50m", "memory": "75Mi" }, - "requests": { "cpu": "50m", "memory": "52Mi" }, - } + resources: {"limits": {"cpu": "50m", "memory": "75Mi"}, "requests": {"cpu": "50m", "memory": "52Mi"}} extraArgs: prometheus-address: http://gmp-proxy/ storage: prometheus admissionController: - enabled: false \ No newline at end of file + enabled: false diff --git a/installation/config/gke/cert-manager-values.yaml b/installation/config/gke/cert-manager-values.yaml deleted file mode 100644 index e69de29..0000000