diff --git a/content/architecture.md b/content/architecture.md index 1334060..6426de2 100644 --- a/content/architecture.md +++ b/content/architecture.md @@ -3,8 +3,8 @@ FinOps Stack makes use of a wide range of software to provide a highly efficient Stack: - **[Kyverno](https://kyverno.io/)**: A Kubernetes-native policy engine that helps enforce, validate, and mutate resource configurations, allowing users to define and manage security, operational, and compliance policies directly as Kubernetes resources. In the FinOps Stack, Kyverno is used to audit or enforce FinOps best practices. -- **[OpenCost](https://www.opencost.io/)**: An open-source cost monitoring and management tool for Kubernetes, designed to provide real-time visibility into the costs associated with workloads, resources, and cloud infrastructure usage in a Kubernetes cluster. In the Stack, we use the OpenCost Prometheus exporter to gather cost metrics, and send these to Google Managed Prometheus. -- **[Goldilocks](https://www.fairwinds.com/goldilocks)**: Fairwinds Goldilocks is designed to provide 'just-right' recommendations for container requests and limits. It does this by using the Vertical Pod Autoscaler in recommendation mode. Additional guidance on interpresting and setting resource reqwuests and limits can be found in our distribution-gke-autopilot guide. +- **[OpenCost](https://www.opencost.io/)**: An open-source cost monitoring and management tool for Kubernetes, designed to provide real-time visibility into the costs associated with workloads, resources, and cloud infrastructure usage in a Kubernetes cluster. In the Stack, we use the OpenCost Prometheus exporter to gather cost metrics, and send these to Prometheus or Google Managed Prometheus when using a GKE cluster. +- **[Goldilocks](https://www.fairwinds.com/goldilocks)**: Fairwinds Goldilocks is designed to provide 'just-right' recommendations for container requests and limits. It does this by using the Vertical Pod Autoscaler in recommendation mode. Additional guidance on interpresting and setting resource requests and limits can be found in our [GKE Autopilot guide](./distribution-gke-autopilot.md). - **[Vertical Pod Autoscaler](https://github.com/kubernetes/autoscaler/blob/master/vertical-pod-autoscaler/README.md)**: frees users from the necessity of setting up-to-date resource limits and requests for the containers in their pods. When configured, it will set the requests automatically based on usage and thus allow proper scheduling onto nodes so that appropriate resource amount is available for each pod. - **[Grafana](https://grafana.com/grafana/)**: An open-source platform used for monitoring and visualising time-series data from various sources, allowing users to create interactive and real-time dashboards for metrics, logs, and analytics. The FinOps Stack uses Grafana to provide visualisations of cost and efficiency metrics. - **gmp-proxy**: A proxy designed to simplify the integration between open-source Grafana and Google Managed Prometheus. diff --git a/content/install.md b/content/install.md index 63969c3..38fb5ba 100644 --- a/content/install.md +++ b/content/install.md @@ -6,7 +6,9 @@ title: Quickstart To simplify installation, the FinOps Stack is installed using a single Helmfile command. -The following instructions are designed to work with GKE standard and GKE autopilot. For full instructions, prerequisites and customisations, please see the [installation README](https://github.com/jetstack/finops-stack/blob/main/installation/README.md). +The following instructions are designed to work with a Kind cluster for quick setup. For full instructions, prerequisites and customisations, please see the [installation README](https://github.com/jetstack/finops-stack/blob/main/installation/README.md). + +To work with GKE standard and GKE autopilot see the [ GKE installation guide]((https://github.com/jetstack/finops-stack/blob/main/installation/README.md)) ### Helmfile @@ -15,7 +17,10 @@ The following instructions are designed to work with GKE standard and GKE autopi git clone https://github.com/jetstack/finops-stack.git ``` -2. In the `/installation` directory, copy `./env.tmpl` to `./.env`. Replace the env var values accordingly. As a minimum, you will need to change the GCP_PROJECT, CSP_API_KEY, GRAFANA_SA_ANNOTATION values. +2. In the [installation](https://github.com/jetstack/finops-stack/blob/main/installation/) directory, Copy env.tmpl file and replace the env var values accordingly (`GRAFANA_FQDN` for example). +```shell +cp ./env.tmpl ./.env +``` 3. Install using helmfile: diff --git a/content/intro.md b/content/intro.md index 9606252..f0c58cc 100644 --- a/content/intro.md +++ b/content/intro.md @@ -6,7 +6,7 @@ The FinOps Stack is the blueprint for a solution to automate FinOps best practic Our goal is to empower organisations with the tools they need to manage, visualise, and optimise their cloud resources in complex, ever-changing environments. -The FinOps Stack is designed to work out-of-the-box seamlessly with GKE standard/autopilot clusters using Google Managed Prometheus, and can be customised for an organisation’s business requirements and/or Kubernetes distribution. +The FinOps Stack is designed to work out-of-the-box seamlessly with GKE standard/autopilot clusters using Google Managed Prometheus, and can be customised for an organisation’s business requirements and/or Kubernetes distribution. Additionally, there is an option to deploy the FinOps Stack on a Kind cluster for a quick setup, allowing you to explore its functionality. ## Key Features and Capabilities