From 6a1fea183306ac46cbbb99ca4871950dbdae5d0f Mon Sep 17 00:00:00 2001 From: Olga Pudrovska Date: Wed, 22 Nov 2023 16:34:38 +0100 Subject: [PATCH] Fix broken links, spaces, and capitalization of `Weave GitOps` (#3653) Minor spelling fixes. Generate protobuf definitions. --- .github/workflows/acceptance-test.yaml | 2 +- CONTRIBUTING.md | 4 +- api/gitauth/gitauth.proto | 6 +- api/gitauth/gitauth.swagger.json | 4 +- .../api/cluster_services.proto | 4 +- .../api/cluster_services.swagger.json | 4 +- .../pkg/protos/cluster_services_grpc.pb.go | 8 +-- cmd/gitops/app/bootstrap/cmd.go | 2 +- docs/architecture/README.md | 32 +++++----- docs/architecture/application-delivery.md | 6 +- docs/architecture/devex.md | 2 +- docs/architecture/explore.md | 2 +- docs/architecture/self-service.md | 10 ++-- docs/architecture/trusted-delivery.md | 4 +- docs/cicd.md | 8 +-- docs/code-quality.md | 6 +- docs/cost-estimation.md | 2 +- docs/monitoring-performance.md | 60 ++++++++----------- docs/releasing.md | 2 +- docs/ui-customization.md | 2 +- hack/azure-marketplace/user-guide.md | 4 +- pkg/api/gitauth/gitauth.pb.go | 2 +- pkg/api/gitauth/gitauth_grpc.pb.go | 2 +- pkg/bootstrap/steps/install_wge.go | 4 +- test/acceptance/test/utils.go | 4 +- test/acceptance/test/utils_git.go | 2 +- .../Secrets/__tests__/SecretDetails.test.tsx | 2 +- 27 files changed, 91 insertions(+), 99 deletions(-) diff --git a/.github/workflows/acceptance-test.yaml b/.github/workflows/acceptance-test.yaml index 4971ac9385..51f995b1dc 100644 --- a/.github/workflows/acceptance-test.yaml +++ b/.github/workflows/acceptance-test.yaml @@ -74,7 +74,7 @@ on: description: "Cluster user admin password hash" required: true WGE_DEX_CLIENT_SECRET: - description: "client credential secret for managment cluster OIDC (dex)" + description: "client credential secret for management cluster OIDC (dex)" required: true WGE_DEX_CLI_CLIENT_SECRET: description: "client credential secret for CLI OIDC (dex)" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a8c17a39bc..3782ad29d9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -366,7 +366,7 @@ $ ./tools/create-leaf-cluster.sh leaf-cluster-01 This command will create a new cluster and configure the `GitopsCluster` CR pointing to the cluster's kubeconfig. -Note that this won't configure completelly the cluster, you might need to install flux and rbac rules in order to be able to query it properly. But it should be already visible on the Weave Gitops cluster's tab. +Note that this won't configure completelly the cluster, you might need to install flux and rbac rules in order to be able to query it properly. But it should be already visible on the Weave GitOps cluster's tab. ### How to install everything from your working branch on a cluster @@ -581,7 +581,7 @@ make core-ui && make core-lib ```bash export WG_VERSION=0.2.4 -# 1.update the backend golang code +# 1. Update the backend Golang code go get -d github.com/weaveworks/weave-gitops@$WG_VERSION go mod tidy diff --git a/api/gitauth/gitauth.proto b/api/gitauth/gitauth.proto index 48413a24b9..92f86f6659 100644 --- a/api/gitauth/gitauth.proto +++ b/api/gitauth/gitauth.proto @@ -1,6 +1,6 @@ /** * This file holds the protobuf definitions - * for the Weave Gitops Enterprise Git Provider Authentication API. + * for the Weave GitOps Enterprise Git Provider Authentication API. */ syntax = "proto3"; @@ -13,10 +13,10 @@ option go_package = "github.com/weaveworks/weave-gitops-enterprise/gitauth/api"; option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = { info: { - title: "Weave Gitops Enterprise GitAuth API", + title: "Weave GitOps Enterprise GitAuth API", version: "0.1"; description: - "Weave Gitops Enterprise GitAuth API handles authentication" + "Weave GitOps Enterprise GitAuth API handles authentication" " via Github and Gitlab"; }; consumes: "gitauth/json"; diff --git a/api/gitauth/gitauth.swagger.json b/api/gitauth/gitauth.swagger.json index b68c078d81..0f6ff41c26 100644 --- a/api/gitauth/gitauth.swagger.json +++ b/api/gitauth/gitauth.swagger.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "Weave Gitops Enterprise GitAuth API", - "description": "Weave Gitops Enterprise GitAuth API handles authentication via Github and Gitlab", + "title": "Weave GitOps Enterprise GitAuth API", + "description": "Weave GitOps Enterprise GitAuth API handles authentication via Github and Gitlab", "version": "0.1" }, "tags": [ diff --git a/cmd/clusters-service/api/cluster_services.proto b/cmd/clusters-service/api/cluster_services.proto index 597621625d..9d85016aca 100644 --- a/cmd/clusters-service/api/cluster_services.proto +++ b/cmd/clusters-service/api/cluster_services.proto @@ -164,7 +164,7 @@ service ClustersService { }; } - // Get the Weave Gitops Enterprise version + // Get the Weave GitOps Enterprise version rpc GetEnterpriseVersion(GetEnterpriseVersionRequest) returns (GetEnterpriseVersionResponse) { option (google.api.http) = { // Namespaced under /enterprise/ so as not to conflict with the OSS endpoint @@ -172,7 +172,7 @@ service ClustersService { }; } - // Get the Weave Gitops Enterprise configuration + // Get the Weave GitOps Enterprise configuration rpc GetConfig(GetConfigRequest) returns (GetConfigResponse) { option (google.api.http) = { get : "/v1/config" diff --git a/cmd/clusters-service/api/cluster_services.swagger.json b/cmd/clusters-service/api/cluster_services.swagger.json index e015c40736..e71514299c 100644 --- a/cmd/clusters-service/api/cluster_services.swagger.json +++ b/cmd/clusters-service/api/cluster_services.swagger.json @@ -263,7 +263,7 @@ }, "/v1/config": { "get": { - "summary": "Get the Weave Gitops Enterprise configuration", + "summary": "Get the Weave GitOps Enterprise configuration", "operationId": "ClustersService_GetConfig", "responses": { "200": { @@ -368,7 +368,7 @@ }, "/v1/enterprise/version": { "get": { - "summary": "Get the Weave Gitops Enterprise version", + "summary": "Get the Weave GitOps Enterprise version", "operationId": "ClustersService_GetEnterpriseVersion", "responses": { "200": { diff --git a/cmd/clusters-service/pkg/protos/cluster_services_grpc.pb.go b/cmd/clusters-service/pkg/protos/cluster_services_grpc.pb.go index e4592b666b..6284d8568c 100644 --- a/cmd/clusters-service/pkg/protos/cluster_services_grpc.pb.go +++ b/cmd/clusters-service/pkg/protos/cluster_services_grpc.pb.go @@ -64,9 +64,9 @@ type ClustersServiceClient interface { // // Provide the name and namespace of a `GitOpsCluster` to retrieve its kubeconfig GetKubeconfig(ctx context.Context, in *GetKubeconfigRequest, opts ...grpc.CallOption) (*httpbody.HttpBody, error) - // Get the Weave Gitops Enterprise version + // Get the Weave GitOps Enterprise version GetEnterpriseVersion(ctx context.Context, in *GetEnterpriseVersionRequest, opts ...grpc.CallOption) (*GetEnterpriseVersionResponse, error) - // Get the Weave Gitops Enterprise configuration + // Get the Weave GitOps Enterprise configuration GetConfig(ctx context.Context, in *GetConfigRequest, opts ...grpc.CallOption) (*GetConfigResponse, error) // List the kubernetes events for a resource ListEvents(ctx context.Context, in *ListEventsRequest, opts ...grpc.CallOption) (*ListEventsResponse, error) @@ -462,9 +462,9 @@ type ClustersServiceServer interface { // // Provide the name and namespace of a `GitOpsCluster` to retrieve its kubeconfig GetKubeconfig(context.Context, *GetKubeconfigRequest) (*httpbody.HttpBody, error) - // Get the Weave Gitops Enterprise version + // Get the Weave GitOps Enterprise version GetEnterpriseVersion(context.Context, *GetEnterpriseVersionRequest) (*GetEnterpriseVersionResponse, error) - // Get the Weave Gitops Enterprise configuration + // Get the Weave GitOps Enterprise configuration GetConfig(context.Context, *GetConfigRequest) (*GetConfigResponse, error) // List the kubernetes events for a resource ListEvents(context.Context, *ListEventsRequest) (*ListEventsResponse, error) diff --git a/cmd/gitops/app/bootstrap/cmd.go b/cmd/gitops/app/bootstrap/cmd.go index 23d6ce40da..533911b964 100644 --- a/cmd/gitops/app/bootstrap/cmd.go +++ b/cmd/gitops/app/bootstrap/cmd.go @@ -17,7 +17,7 @@ const ( cmdLongDescription = `Installs Weave GitOps Enterprise in simple steps: - Entitlements: check that you have valid entitlements. - Flux: check or bootstrap Flux. -- Weave Gitops: check or install a supported Weave GitOps version with default configuration. +- Weave GitOps: check or install a supported Weave GitOps version with default configuration. - Authentication: check or setup cluster user authentication to access the dashboard. ` cmdExamples = ` diff --git a/docs/architecture/README.md b/docs/architecture/README.md index 17df789129..1c3bf32f3a 100644 --- a/docs/architecture/README.md +++ b/docs/architecture/README.md @@ -25,12 +25,12 @@ Diagrams aim to be self-explanatory however: ## Getting Started -It depends on your expected outcome. This section assumes that you are an engineering within Weave Gitops and you are onboarding +It depends on your expected outcome. This section assumes that you are an engineering within Weave GitOps and you are onboarding to the product within a particular business domain. We suggest you use this documentation as part of the onboarding to get started: -1. Head to [Weave Gitops System](#system) as it provides you a high-level understanding on who are the users and Weave Gitops Dependencies. -2. Review [Weave Gitops Tiers](#tiers) as it provides with the layering of the application and access to the codebase by tier. -3. View the [Weave Gitops Domain](#domains) to provide you a high level overview of the problem spaces that Weave Gitops faces. +1. Head to [Weave GitOps System](#system) as it provides you a high-level understanding on who are the users and Weave GitOps Dependencies. +2. Review [Weave GitOps Tiers](#tiers) as it provides with the layering of the application and access to the codebase by tier. +3. View the [Weave GitOps Domain](#domains) to provide you a high level overview of the problem spaces that Weave GitOps faces. 4. Select the domain that you would be contributing to. Understand the solution space via - its diagram and user flows, - follow the tiers approach UI -> API -> Backend, @@ -120,11 +120,11 @@ More info about each of them could be found within their domain. See [domains vi ### Scalability, High Availability and Disaster Recovery -#### Weave Gitops Enterprise Management Console +#### Weave GitOps Enterprise Management Console -In terms of scalability Weave Gitops Enterprise Management Console presents the following features: +In terms of scalability Weave GitOps Enterprise Management Console presents the following features: -- It uses golang's HTTP infrastructure which handles concurrent connections efficiently, so API server instances scale well vertically +- It uses Golang's HTTP infrastructure which handles concurrent connections efficiently, so API server instances scale well vertically - In terms of scalability models, Weave GitOps Enterprise management app could scale vertically to simplify operations, or it could also do it horizontally as: - User sessions are self-contained in cookies that comes in each user request. @@ -132,7 +132,7 @@ it could also do it horizontally as: - Our data layer is cache layer with read-only capabilities that lives alongside each of the server instances. - High Availability can be achieved by having multiple API server instanced behind a load balancer with sticky sessions enabled. - Disaster Recovery for the app, as the state is hold in Kubernetes, follows the same approach as any other stateless application and - to be determined by the DR strategy of the team running the platform running Weave Gitops Enterprise. + to be determined by the DR strategy of the team running the platform running Weave GitOps Enterprise. #### Kubernetes Controllers @@ -143,7 +143,7 @@ About the Kubernetes controllers the following statements are true: - These controllers are built in Go following Kubernetes industry-standard approach based on [kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) and [controller runtime,](https://github.com/kubernetes-sigs/controller-runtime) so they could achieve HA via multiple instances with enabled [leader-election](https://pkg.go.dev/github.com/kubernetes-sigs/controller-runtime/pkg/leaderelection). - Disaster Recovery for controllers, as the state is hold in kubernetes, follows the same approach as any other stateless application and -to be determined by the DR strategy of the team running the platform running Weave Gitops Enterprise. +to be determined by the DR strategy of the team running the platform running Weave GitOps Enterprise. ## Weave GitOps Enterprise @@ -179,17 +179,17 @@ WGE sits on top or integrate a set of external systems for gitops delivery and r The following diagram represents the system as a whole. The following considerations might be useful to be fully understand the diagram: -- Weave Gitops Cluster is represented once for simplicity but in reality is presented as: - - Weave Gitops Management Cluster: single instance that holds the management console and control plane controllers. - - Weave Gitops Leaf Cluster: multiple instances that run business applications and managed by Weave Gitops Management Cluster. +- Weave GitOps Cluster is represented once for simplicity but in reality is presented as: + - Weave GitOps Management Cluster: single instance that holds the management console and control plane controllers. + - Weave GitOps Leaf Cluster: multiple instances that run business applications and managed by Weave GitOps Management Cluster. - In terms of **data-flows**, the line starts by the source entity starting the connection and commonly starting a request. For example, -Weave Gitops Enterprise opens connections to a Git Provider api for example to request creating a Pull Request. +Weave GitOps Enterprise opens connections to a Git Provider api for example to request creating a Pull Request. - In terms of **networks**, we could say that: - - Weave Gitops Cluster: + - Weave GitOps Cluster: - All components from a cluster lives in the same kubernetes cluster so under the same kubernetes control plane that would be commonly deployed in the same network (for example in a VPC). - - Communication between Weave Gitops Management and Weave Gitops Leaf clusters happens via Kubernetes API so needs to be accessible. + - Communication between Weave GitOps Management and Weave GitOps Leaf clusters happens via Kubernetes API so needs to be accessible. - Platform Engineers or Developers consumes the app via a web browser that would communicate with the API server via either public or private networks depending on the customer deployment. - External Systems outside Management or Leaf could communicate via public or private network depending on the customer needs and requirements. For example, it could communicate with GitHub via internet if using the hosted version, or via internal network if using GitHub Enterprise self-hosted. @@ -222,7 +222,7 @@ C4Context UpdateRelStyle(WeaveGitopsEnterprise, Idp, $offsetX="-50", $offsetY="-20") - Boundary(Runtime, "Weave Gitops Cluster") { + Boundary(Runtime, "Weave GitOps Cluster") { Boundary(Kubernetes, "Kubernetes") { System_Ext(KubernetesCluster, "Kubernetes Cluster", "run customer applications") } diff --git a/docs/architecture/application-delivery.md b/docs/architecture/application-delivery.md index d86ab2112e..570744ce3f 100644 --- a/docs/architecture/application-delivery.md +++ b/docs/architecture/application-delivery.md @@ -1,5 +1,5 @@ # Application Delivery -This document outlines an architecture documentation for Weave Gitops Application Delivery domain. +This document outlines an architecture documentation for Weave GitOps Application Delivery domain. ## Motivation As software business, value is delivered to the users or customers by enabling them to do actions. @@ -26,8 +26,8 @@ Pipelines enables a user to deliver application changes across different environ There are three main pipeline journeys: 1. As developer, to add a pipeline for my application, which is a regular gitops flow [Pipeline](https://docs.gitops.weave.works/docs/pipelines/spec/v1alpha1/pipeline/) -2. As developer to view my application pipelines via [Weave Gitops UI](https://docs.gitops.weave.works/docs/pipelines/getting-started/) -3. As developer to promote my application along the pipeline stages via [Weave Gitops UI](https://docs.gitops.weave.works/docs/pipelines/promoting-applications/) +2. As developer to view my application pipelines via [Weave GitOps UI](https://docs.gitops.weave.works/docs/pipelines/getting-started/) +3. As developer to promote my application along the pipeline stages via [Weave GitOps UI](https://docs.gitops.weave.works/docs/pipelines/promoting-applications/) ```mermaid C4Component diff --git a/docs/architecture/devex.md b/docs/architecture/devex.md index 76858629ed..6275800350 100644 --- a/docs/architecture/devex.md +++ b/docs/architecture/devex.md @@ -1,5 +1,5 @@ # Development Experience -This document outlines an architecture documentation for Weave Gitops Development Experience domain +This document outlines an architecture documentation for Weave GitOps Development Experience domain ## Motivation diff --git a/docs/architecture/explore.md b/docs/architecture/explore.md index 8f40c3280a..4e97435909 100644 --- a/docs/architecture/explore.md +++ b/docs/architecture/explore.md @@ -12,7 +12,7 @@ Explore is the capability that allows searching across multiple infrastructure d There is a single user journey: -1. As developer, I like to search for resources across my platform using [Weave Gitops UI](https://docs.gitops.weave.works/docs/explorer/getting-started/) +1. As developer, I like to search for resources across my platform using [Weave GitOps UI](https://docs.gitops.weave.works/docs/explorer/getting-started/) There are two main components: diff --git a/docs/architecture/self-service.md b/docs/architecture/self-service.md index aa0dd42325..bd146c24ae 100644 --- a/docs/architecture/self-service.md +++ b/docs/architecture/self-service.md @@ -83,9 +83,9 @@ GitOpsTemplates enable Application Developers to self-service components and ser User flows are two: 1. make a template available which uses a regular gitops flow for [GitopsTemplate](https://docs.gitops.weave.works/docs/gitops-templates/creating-templates/) resource. 2. use or update a GitopsTemplate where - 1. A platform engineering searches and select the temaplate to use via Weave Gitops UI. - 2. Fills the template and submits the template rendering request to Weave Gitops. - 3. Authenticates with GitProvider or git provider via Weave Gitops + 1. A platform engineering searches and select the temaplate to use via Weave GitOps UI. + 2. Fills the template and submits the template rendering request to Weave GitOps. + 3. Authenticates with GitProvider or git provider via Weave GitOps 4. Weave GitOps creates a PR in the provider with the generated resources. ```mermaid @@ -145,8 +145,8 @@ User flows are two: 1. To make a profile available which uses a regular gitops flow for [Helm Releases](https://docs.gitops.weave.works/docs/cluster-management/profiles/). 2. Add profiles to your clusters via cluster creation or [adding an application](https://docs.gitops.weave.works/docs/cluster-management/add-applications/): 1. A platform engineering selects the profiles repository, application, layer and application values. - 2. Authenticates with GitProvider or git provider via Weave Gitops. - 3. Weave gitops creates a PR with the profile HelmRelease/HelmRepository. + 2. Authenticates with GitProvider or git provider via Weave GitOps. + 3. Weave GitOps creates a PR with the profile HelmRelease/HelmRepository. 4. Source controller syncs after merge 5. Helm Controller deploys the helm release diff --git a/docs/architecture/trusted-delivery.md b/docs/architecture/trusted-delivery.md index daffa04373..c498f15946 100644 --- a/docs/architecture/trusted-delivery.md +++ b/docs/architecture/trusted-delivery.md @@ -1,5 +1,5 @@ # Trusted Delivery -This document outlines an architecture documentation for Weave Gitops Trusted Delivery domain. +This document outlines an architecture documentation for Weave GitOps Trusted Delivery domain. ## Motivation @@ -31,7 +31,7 @@ And the following flows: 1. A platform engineer via gitops flow, to provision the policy runtime and library via policy profile. 2. A platform engineer via gitops flow, add custom policies or policy config. 3. Policy runtime to enforce policies and send policy events to external system like ELK. -4. Platform engineer to view policy violations via Weave Gitops UI. +4. Platform engineer to view policy violations via Weave GitOps UI. ```mermaid C4Component diff --git a/docs/cicd.md b/docs/cicd.md index bdc9f0cdb1..1ffa4cbced 100644 --- a/docs/cicd.md +++ b/docs/cicd.md @@ -1,8 +1,8 @@ -# Weave Gitops Enterprise CI/CD +# Weave GitOps Enterprise CI/CD This document aims to characterise the Ci/CD pipeline for change until it reaches production. In our context, given that we are not SaaS company, our definition of production environment -is until the change gets released as part of a [Weave Gitops release](https://github.com/weaveworks/weave-gitops-enterprise/releases) +is until the change gets released as part of a [Weave GitOps release](https://github.com/weaveworks/weave-gitops-enterprise/releases) As expected, Flux for deployment and Github Actions as CI. ## PR Journey @@ -23,7 +23,7 @@ The journey of a Weaveworks engineer development is the following: deployed to [Staging](https://gitops.internal-dev.wego-gke.weave.works) environment by Flux. This environment helps us to: - Functional testing of the feature in a released environment - Monitor performance of the capability -6. The feature will be released according to the week-release cadence that we have for Weave Gitops. +6. The feature will be released according to the week-release cadence that we have for Weave GitOps. ## Environments @@ -34,4 +34,4 @@ that we use to recreate the application locally. See [Tiltfile](../Tiltfile). - Test/Staging: once code gets into main branch, it gets deployed to [Staging](https://gitops.internal-dev.wego-gke.weave.works) environment where a developer is able to monitor its behaviour in a long-lived environment. - Production: we don't have a production environment as compared to a SaaS company, as our product gets deployed by customers in their environments. However, we have internal -customers (ex. Sales) that provide us early-feedback for any new Weave Gitops Enterprise release. +customers (ex. Sales) that provide us early-feedback for any new Weave GitOps Enterprise release. diff --git a/docs/code-quality.md b/docs/code-quality.md index 3e61f0354d..24614f7ab5 100644 --- a/docs/code-quality.md +++ b/docs/code-quality.md @@ -1,6 +1,6 @@ # Code Quality and Security -This doc provides an overview on the actions taken for code quality and security posture for Weave Gitops Enterprise. +This doc provides an overview on the actions taken for code quality and security posture for Weave GitOps Enterprise. ## Code @@ -51,11 +51,11 @@ We have the following three capabilities identified: We use [GitHub Dependabot](https://github.com/dependabot) for vulnerability management. They are actively reviewed and managed via PR associated with the engineering teams. -![dependandbot security alerts for Weave Gitops Enterprise](resources/dependandbot-security-alerts.png) +![dependandbot security alerts for Weave GitOps Enterprise](resources/dependandbot-security-alerts.png) ### License Checking -We use Fossa for doing license checking. An example of it could be seen in [Weave Gitops OSS](https://app.fossa.com/reports/005da7c4-1f10-4889-9432-8b97c2084e41) +We use Fossa for doing license checking. An example of it could be seen in [Weave GitOps OSS](https://app.fossa.com/reports/005da7c4-1f10-4889-9432-8b97c2084e41) ### Static Code Analysis diff --git a/docs/cost-estimation.md b/docs/cost-estimation.md index 46535ca7f8..a2f70aa1dd 100644 --- a/docs/cost-estimation.md +++ b/docs/cost-estimation.md @@ -10,7 +10,7 @@ Cost estimation was requested by a specific customer (IQT) and is not available ## Enabling -We make some configuration changes to the `values` in the Weave Gitops Enterprise `HelmRelease`. +We make some configuration changes to the `values` in the Weave GitOps Enterprise `HelmRelease`. ### AWS CSV Pricer diff --git a/docs/monitoring-performance.md b/docs/monitoring-performance.md index af496469ec..67b6d008da 100644 --- a/docs/monitoring-performance.md +++ b/docs/monitoring-performance.md @@ -1,16 +1,14 @@ -# Monitoring Performance for Weave Gitops Enterprise +# Monitoring Performance for Weave GitOps Enterprise -This document tries to provide an overview of performance monitoring for Weave Gitops Enterprise from two angles: -- how it looks in general and +This document tries to provide an overview of performance monitoring for Weave GitOps Enterprise from two angles: +- how it looks in general and - how it could be used for troubleshooting performance issues. ## Monitoring Overview ### Metrics -Performance monitoring for Weave Gitops Enterprise happens mostly driven by metrics. Both the management console and controllers -are instrumented to generate Prometheus metrics. In addition, given that our applications are deployed to Kubernetes, -Kubernetes metrics for workloads are also used. In summary, we have the main three monitoring layers: +Performance monitoring for Weave GitOps Enterprise happens mostly driven by metrics. Both the management console and controllers are instrumented to generate Prometheus metrics. In addition, given that our applications are deployed to Kubernetes, Kubernetes metrics for workloads are also used. In summary, we have the main three monitoring layers: **Go runtime metrics via [prometheus client_golang](https://github.com/prometheus/client_golang/blob/1bae6c1e6314f6a20be183a7277059630780232a/prometheus/collectors/go_collector_latest.go)** @@ -22,36 +20,34 @@ Kubernetes metrics for workloads are also used. In summary, we have the main thr **Component server metrics** -An example for [Explorer](https://github.com/weaveworks/weave-gitops-enterprise/blob/b643619464104e59a17e77a697cd7c290f96889a/pkg/query/collector/metrics/recorder.go) could be -seen here: +An example for [Explorer](https://github.com/weaveworks/weave-gitops-enterprise/blob/b643619464104e59a17e77a697cd7c290f96889a/pkg/query/collector/metrics/recorder.go) could be seen here: -![explorer emtrics](monitoring/imgs/explorer-query-metrics-87ba3ddbfb12169b31b27e4f9ea8c722.png) +![explorer metrics](monitoring/imgs/explorer-query-metrics-87ba3ddbfb12169b31b27e4f9ea8c722.png) **Kubernetes Workload metrics** ![overview-kubernetes.png](monitoring/imgs/overview-kubernetes.png) -The monitoring stack is deployed as [Flux Kustomization](https://github.com/weaveworks/weave-gitops-quickstart/tree/add-monitoring) that includes: +The monitoring stack is deployed as [Flux Kustomization](https://github.com/weaveworks/weave-gitops-quickstart/tree/main/monitoring) that includes: -- Prometheus +- Prometheus - Grafana - Kubernetes Dashboards -- Flux Dashboards -- Weave Gitops Grafana dashboards +- Flux Dashboards +- Weave GitOps Grafana dashboards This is included in: - [Dev environment](../tools/dev-resources/monitoring/wge-monitoring.yaml) so it could be used during development for understanding feature performance. -- [Staging cluster](https://github.com/weaveworks/weave-gitops-clusters/tree/main/k8s/clusters/internal-dev-gke/monitoring) so it could be used to long-live monitoring a feature or the app. +- [Staging cluster](https://github.com/weaveworks/weave-gitops-clusters/tree/main/k8s/clusters/internal-dev-gke/monitoring) so it could be used to long-live monitoring a feature or the app. ### Profiling -Apart from metrics, Weave Gitops Enterprise leverages golang profiling capabilities [pprof](https://pkg.go.dev/runtime/pprof) -for complementing the understanding provided via metrics. For an example on using metrics and profiling for troubleshooting -memory leaks, see [troubleshooting performance](#troubleshooting-performance-issues). +Apart from metrics, Weave GitOps Enterprise leverages Golang profiling capabilities [pprof](https://pkg.go.dev/runtime/pprof) +for complementing the understanding provided via metrics. For an example on using metrics and profiling for troubleshooting memory leaks, see [troubleshooting performance](#troubleshooting-performance-issues). Any environment could by profiled by enabling the configuration [`WEAVE_GITOPS_ENABLE_PROFILING`](https://github.com/weaveworks/weave-gitops-enterprise/blob/b643619464104e59a17e77a697cd7c290f96889a/cmd/clusters-service/app/server.go#L843) -that exposes an [http endpoint for pprof](https://pkg.go.dev/net/http/pprof) for any of the available profiles. +that exposes an [http endpoint for pprof](https://pkg.go.dev/net/http/pprof) for any of the available profiles. Then it could be used remote or locally used via pprof tool. An example a memory heap dump visualised via pprof `go tool pprof -http=:8082 heap` could be: @@ -61,31 +57,28 @@ Profiling is enabled by default in [dev via Tilt](../tools/dev-values.yaml) ## Troubleshooting Performance Issues -As developer, we build up features that requires compute resources. Apart from functional requirements, we -expect to behave in en efficient way in terms of performance and compute resources usage. +As developer, we build up features that requires compute resources. Apart from functional requirements, we expect to behave in en efficient way in terms of performance and compute resources usage. -This section guides you on an approach that could be useful to determine performance issues. In particular, we are going -to focus on memory leaks as an example based on the experience gathered out of [this issue](https://github.com/weaveworks/weave-gitops-enterprise/issues/3189). +This section guides you on an approach that could be useful to determine performance issues. In particular, we are going to focus on memory leaks as an example based on the experience gathered out of [this issue](https://github.com/weaveworks/weave-gitops-enterprise/issues/3189). ### Setup -- An instance of Weave Gitops Enterprise with Monitoring stack deployed. -- The monitoring stack deployed [Flux Kustomization](https://github.com/weaveworks/weave-gitops-quickstart/tree/add-monitoring) that includes: -- Enabled [metrics](https://docs.gitops.weave.works/docs/references/helm-reference/) +- An instance of Weave GitOps Enterprise with Monitoring stack deployed. +- The monitoring stack deployed [Flux Kustomization](https://github.com/weaveworks/weave-gitops-quickstart/tree/main/monitoring) that includes: +- Enabled [metrics](https://docs.gitops.weave.works/docs/operations/monitoring/#setup) - Enabled [profiling](https://github.com/weaveworks/weave-gitops-enterprise/blob/b643619464104e59a17e77a697cd7c290f96889a/cmd/clusters-service/app/server.go#L843) ### Detect memory leaks -There could be different ways to detect that you might be facing a memory leak. One of them could have an ever-growing -memory usage for you container as shown by the following picture: +There could be different ways to detect that you might be facing a memory leak. One of them could have an ever-growing memory usage for you container as shown by the following picture: ![memory usage ever growing](monitoring/imgs/memory-leak-profile.png) At this point you determine how you memory heap looks like following these steps: -1. Download a heap dump for weave gitops by adding `/debug/pprof/heap` to your WGE URL (For example https://wge-3189-fix.eng-sandbox.weave.works/debug/pprof/heap). +1. Download a heap dump for Weave GitOps by adding `/debug/pprof/heap` to your WGE URL (For example https://wge-3189-fix.eng-sandbox.weave.works/debug/pprof/heap). 2. Start pprof web interface by `go tool pprof -http=:8082 heap` -3. Navigate to your browser http://localhost:8082/ui/ and the UI will open like the following +3. Navigate to your browser http://localhost:8082/ui/ and the UI will open like the following ![pprof web ui overview](monitoring/imgs/pprof-web-ui.png) @@ -94,21 +87,20 @@ Use the pprof view that better helps you understand these two questions: 1. What is the function that is generating objects for the heap that are not freed? 2. What is the call chain that ends up calling the function? -For example, +For example, The following `inuse_objects` tell us that the 22% of objects are being generated from `GetServerClient` -where we expected that server connections were cached. +where we expected that server connections were cached. ![graph-server-connections.png](monitoring/imgs/graph-server-connections.png) -which indicate that we had an issue around that feature. +which indicate that we had an issue around that feature. Once we identified the issue with the [cache](https://github.com/weaveworks/weave-gitops/commit/c6cc497d3c09bcadf019236ec2be8cb08b7e7d02) and released the change, we could monitor the impact in the dashboard: ![metrics-server-connections.png](monitoring/imgs/metrics-server-connections.png) -Where we could see how the memory used and the heap flatten as a result of the change. +Where we could see how the memory is used and the heap flattens as a result of the change. These steps could require iteration until the cause is found and addressed. - diff --git a/docs/releasing.md b/docs/releasing.md index 9f95000f8a..a73b70d17f 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -112,7 +112,7 @@ Ensure that the version referenced in the instructions for downloading the CLI a Sample: -> Hi! There is a new release of Weave Gitops Enterprise v0.9.6! +> Hi! There is a new release of Weave GitOps Enterprise v0.9.6! > - https://github.com/weaveworks/weave-gitops-enterprise/releases/tag/v0.9.6 > - https://docs.gitops.weave.works/docs/enterprise/getting-started/releases-enterprise/ diff --git a/docs/ui-customization.md b/docs/ui-customization.md index 54fa1b6811..000d5a4b32 100644 --- a/docs/ui-customization.md +++ b/docs/ui-customization.md @@ -5,7 +5,7 @@ We support the following custom GUI elements: ## Enabling -We make some configuration changes to the `values` in the Weave Gitops Enterprise `HelmRelease`. +We make some configuration changes to the `values` in the Weave GitOps Enterprise `HelmRelease`. ```yaml logoURL: http://iqt.dev/iqt.svg diff --git a/hack/azure-marketplace/user-guide.md b/hack/azure-marketplace/user-guide.md index 4f654aab6d..5efe530e3c 100644 --- a/hack/azure-marketplace/user-guide.md +++ b/hack/azure-marketplace/user-guide.md @@ -56,9 +56,9 @@ kubectl create secret generic cluster-user-auth \ --from-literal=password='$2a$.......' ``` -## 6. Install the Weave Gitops Enterprise +## 6. Install the Weave GitOps Enterprise -Navigate to the Marketplace in the azure portal and add the Weave Gitops Enterprise Offering, during configuration select the cluster we've performed the configuration on. +Navigate to the Marketplace in the azure portal and add the Weave GitOps Enterprise Offering, during configuration select the cluster we've performed the configuration on. ## 7. Extra configuration diff --git a/pkg/api/gitauth/gitauth.pb.go b/pkg/api/gitauth/gitauth.pb.go index 2e541b34ec..2e9e54b23e 100644 --- a/pkg/api/gitauth/gitauth.pb.go +++ b/pkg/api/gitauth/gitauth.pb.go @@ -1,6 +1,6 @@ // // This file holds the protobuf definitions -// for the Weave Gitops Enterprise Git Provider Authentication API. +// for the Weave GitOps Enterprise Git Provider Authentication API. // Code generated by protoc-gen-go. DO NOT EDIT. // versions: diff --git a/pkg/api/gitauth/gitauth_grpc.pb.go b/pkg/api/gitauth/gitauth_grpc.pb.go index d9380d22a4..93abc8afcc 100644 --- a/pkg/api/gitauth/gitauth_grpc.pb.go +++ b/pkg/api/gitauth/gitauth_grpc.pb.go @@ -1,6 +1,6 @@ // // This file holds the protobuf definitions -// for the Weave Gitops Enterprise Git Provider Authentication API. +// for the Weave GitOps Enterprise Git Provider Authentication API. // Code generated by protoc-gen-go-grpc. DO NOT EDIT. // versions: diff --git a/pkg/bootstrap/steps/install_wge.go b/pkg/bootstrap/steps/install_wge.go index 6ccb8b2dd4..a8482de221 100644 --- a/pkg/bootstrap/steps/install_wge.go +++ b/pkg/bootstrap/steps/install_wge.go @@ -47,7 +47,7 @@ var getUserDomain = StepInput{ Enabled: isUserDomainEnabled, } -// NewInstallWGEStep step to install Weave Gitops Enterprise +// NewInstallWGEStep step to install Weave GitOps Enterprise func NewInstallWGEStep(config Config) BootstrapStep { inputs := []StepInput{} @@ -56,7 +56,7 @@ func NewInstallWGEStep(config Config) BootstrapStep { } return BootstrapStep{ - Name: "install Weave Gitops Enterprise", + Name: "install Weave GitOps Enterprise", Input: inputs, Step: installWge, } diff --git a/test/acceptance/test/utils.go b/test/acceptance/test/utils.go index 27567b002b..89bb6b6b24 100644 --- a/test/acceptance/test/utils.go +++ b/test/acceptance/test/utils.go @@ -129,10 +129,10 @@ func installWeaveGitopsControllers() { repoAbsolutePath := configRepoAbsolutePath(gitProviderEnv) initAndCreateEmptyRepo(gitProviderEnv, true) bootstrapAndVerifyFlux(gitProviderEnv, GITOPS_DEFAULT_NAMESPACE, getGitRepositoryURL(repoAbsolutePath)) - logger.Info("No need to install Weave gitops enterprise controllers, managemnt cluster is already configured and setup.") + logger.Info("No need to install Weave GitOps enterprise controllers, management cluster is already configured and setup.") } else { - logger.Info("Installing Weave gitops controllers on to management cluster along with respective configurations and setting such as config repo creation etc.") + logger.Info("Installing Weave GitOps controllers on to management cluster along with respective configurations and setting such as config repo creation etc.") // Config repo must exist first before installing gitops controller initAndCreateEmptyRepo(gitProviderEnv, true) diff --git a/test/acceptance/test/utils_git.go b/test/acceptance/test/utils_git.go index d59e78a3f5..84ff6aeee1 100644 --- a/test/acceptance/test/utils_git.go +++ b/test/acceptance/test/utils_git.go @@ -167,7 +167,7 @@ func createGitRepository(gp GitProviderEnv, branch string, private bool) error { visibility = gitprovider.RepositoryVisibilityPrivate } - description := "Weave Gitops enterprise test repository" + description := "Weave GitOps enterprise test repository" defaultBranch := branch repoInfo := gitprovider.RepositoryInfo{ Description: &description, diff --git a/ui/src/components/Secrets/__tests__/SecretDetails.test.tsx b/ui/src/components/Secrets/__tests__/SecretDetails.test.tsx index 21ab2619d9..40a6cd2058 100644 --- a/ui/src/components/Secrets/__tests__/SecretDetails.test.tsx +++ b/ui/src/components/Secrets/__tests__/SecretDetails.test.tsx @@ -12,7 +12,7 @@ import SecretDetails from '../SecretDetails'; const MockSecretResponse = { secretName: 'secret Name', externalSecretName: 'external Secret Name', - clusterName: 'managment', + clusterName: 'management', namespace: 'flux-system', secretStore: 'secret Store name', secretStoreType: 'secret Store Type',