Skip to content

Update docs #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maria-reynoso merged 1 commit into from
Mar 14, 2025
Merged

Update docs #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ FinOps Stack makes use of a wide range of software to provide a highly efficient
- **[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.
- **gmp-proxy**: A proxy designed to simplify the integration between open-source Grafana and Google Managed Prometheus (if using a GKE cluster).
- **[Cert-Manager](https://cert-manager.io/)**: An open source tool that provides certificate management for Kubernetes. In the FinOps Stack, cert-manager can be optionally installed to create a tls certificate if using ingress for Grafana.


2 changes: 1 addition & 1 deletion content/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. Additionally, there is an option to deploy the FinOps Stack on a Kind cluster for a quick setup, allowing you to explore its functionality.
The FinOps Stack is designed to work out-of-the-box seamlessly with GKE standard/autopilot clusters using [Google Managed Prometheus](https://cloud.google.com/stackdriver/docs/managed-prometheus), or with an EKS cluster using standard Prometheus. It can be customised for an organisation’s business requirements and/or Kubernetes distribution. Additionally, for a quick setup and exploration, the FinOps Stack can be deployed on a Kind cluster.

## Key Features and Capabilities

Expand Down
5 changes: 3 additions & 2 deletions installation/gke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ Installing Helm charts with lots of dependencies and CRDs is challenging; these
- A GKE standard or autopilot cluster with:
- kubectl access
- cluster-admin permissions
- workload identity enabled
- workload identity enabled
- [Google Managed Prometheus](https://cloud.google.com/stackdriver/docs/managed-prometheus) enabled.
- [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
Expand All @@ -29,7 +30,7 @@ Installing Helm charts with lots of dependencies and CRDs is challenging; these
### 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_gke.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_gke.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

Expand Down