Merge branch 'main' into add-multi-tenancy-public-doc

giantswarm · Dec 13, 2024 · 76a27d9 · 76a27d9
2 parents 62ba86f + 7e84b06
commit 76a27d9
Show file tree

Hide file tree

Showing 53 changed files with 170 additions and 108 deletions.
diff --git a/.github/workflows/create-highlights.yml b/.github/workflows/create-highlights.yml
@@ -38,6 +38,6 @@ jobs:
             This PR has been created automatically by the 'Create highlight PR' Github workflow
             to publish the weekly highlights.
 
-            This action is triggered every Thrusday morning to collect all the highlights from the selected apps in giantswarm/github repository. The highlights are collected from the changelog entries from .github repository apps.
+            This action is triggered every Thursday morning to collect all the highlights from the selected apps in giantswarm/github repository. The highlights are collected from the changelog entries from .github repository apps.
 
             Please review the changes, group the entries for each app making sure it is digestible for the customers and highlight the breaking changes in the top.
diff --git a/Makefile b/Makefile
@@ -130,7 +130,15 @@ docker-run:
 	docker run --rm -ti -p 8080:8080 $(REGISTRY)/$(COMPANY)/$(PROJECT):latest
 
 dev:
-	hugo server -s src
+	hugo server \
+	  --source ./src \
+	  --ignoreCache \
+	  --disableFastRender \
+	  --cleanDestinationDir \
+	  --gc \
+	  --noBuildLock \
+	  --noHTTPCache \
+	  --renderToMemory
 
 clean:
 	rm -rf build

diff --git a/renovate.json5 b/renovate.json5
@@ -2,4 +2,16 @@
   "extends": [
     "github>giantswarm/renovate-presets:default.json5"
   ],
+  customManagers: [
+    // Detect versions in shell scripts
+    {
+      customType: 'regex',
+      fileMatch: ['.*\\.sh'],
+      matchStrings: [
+        // for the version on the right part, ignoring the left
+        '# renovate: datasource=(?<datasource>.*?) depName=(?<depName>.*?)( versioning=(?<versioning>.*?))?\\s[A-Z_]+=(?<currentValue>\\S+)',
+      ],
+      versioningTemplate: '{{#if versioning}}{{{versioning}}}{{else}}semver{{/if}}',
+    },
+  ],
 }
diff --git a/scripts/collect-changelog-entries/script.py b/scripts/collect-changelog-entries/script.py
@@ -92,8 +92,7 @@ def main():
     app_repos = fetch_app_repositories()
 
     # Define the metadata
-    metadata = f"""
----
+    metadata = f"""---
 date: {d}T14:00:00
 title: Highlights for the week ending {d}
 changes_categories:

diff --git a/scripts/update-crd-reference/main.sh b/scripts/update-crd-reference/main.sh
@@ -2,7 +2,9 @@
 
 set -e
 
+# renovate: datasource=docker depName=gsoci.azurecr.io/giantswarm/crd-docs-generator versioning=loose
 CRD_DOCS_GENERATOR_VERSION=0.11.1
+
 DESTINATION=src/content/reference/platform-api/crd
 
 # Clear output folder

diff --git a/scripts/update-helm-chart-reference/main.sh b/scripts/update-helm-chart-reference/main.sh
@@ -1,5 +1,6 @@
 #!/bin/bash
 
+# renovate: datasource=docker depName=gsoci.azurecr.io/giantswarm/helm-chart-docs-generator versioning=loose
 HELM_CHART_DOCS_GENERATOR_VERSION=0.2.0
 
 DESTINATION=src/content/reference/platform-api/cluster-apps

diff --git a/src/.hugo_build.lock b/src/.hugo_build.lock
diff --git a/src/config.yaml b/src/config.yaml
@@ -22,6 +22,7 @@ markup:
     lineNos: false
 
 menu:
+  # main is our Vintage menu
   main:
   - identifier: platform-overview
     name: Platform Overview
@@ -39,39 +40,12 @@ menu:
     name: Use the API
     url: /vintage/use-the-api/
     weight: 40
-  - identifier: support
-    name: Support & Training
-    url: /support/
-    weight: 50
-  - identifier: changes
-    name: Changes and releases
-    url: /changes/
-    weight: 90
-  principal:
-  - identifier: overview
-    name: Overview
-    url: /overview/
-    weight: 10
-  - identifier: getting-started
-    name: Getting started
-    url: /getting-started/
-    weight: 20
-  - identifier: tutorials
-    name: Tutorials
-    url: /tutorials/
-    weight: 30
-  - identifier: reference
-    name: Reference
-    url: /reference/
-    weight: 40
-  - identifier: support
-    name: Support
-    url: /support/
-    weight: 50
-  - identifier: changes
-    name: Changes and releases
-    url: /changes/
-    weight: 90
+
+
+  # principal is the main menu since December 2024.
+  # Entries are assigned via front-matter.
+  principal: []
+
 
 taxonomies:
   changes_category: changes_categories

diff --git a/src/content/changes/_index.md b/src/content/changes/_index.md
@@ -1,7 +1,10 @@
 ---
 title: Changes and Releases
 description: Updates on Giant Swarm workload cluster releases, apps, UI improvements and documentation changes.
-weight: 10
+menu:
+  principal:
+    identifier: changes
+weight: 90
 last_review_date: 2024-02-23
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/src/content/changes/highlights/2024-12-12.md b/src/content/changes/highlights/2024-12-12.md
@@ -0,0 +1,38 @@
+---
+date: 2024-12-12T14:00:00
+title: Highlights for the week ending 2024-12-12
+changes_categories:
+  - Highlights
+owner:
+  - https://github.com/orgs/giantswarm/teams/sig-product
+---
+
+## Observability
+
+- **Grafana App** [v2.18.0](https://github.com/giantswarm/grafana-app/compare/v2.17.0...v2.18.0)
+    - Improved security by blocking default access to certain endpoints (`/swagger`, `/metrics`, and `/api/health`).
+    - Upgraded Grafana for a better user experience and new features (now at version 8.6.0).
+
+- **Prometheus Rules** [v4.30.0](https://github.com/giantswarm/prometheus-rules/compare/v4.27.0...v4.30.0)
+    - New alert added to help identify issues with `KubeadmConfig` configurations.
+    - Reduced unnecessary alerts during tests by ignoring certain HelmReleases.
+    - Added new alerts to quickly detect and resolve `karpenter` issues.
+    - Expanded alert timing for `PromtailRequestsErrors` to reduce false positives (now 25 minutes).
+
+- **Observability Operator** [v0.10.0](https://github.com/giantswarm/observability-operator/compare/v0.9.1...v0.10.0)
+    - Integrated `Mimir`, `Alertmanager` for enhanced alerting.
+    - Enhanced multi-tenant support within `Grafana` organizations.
+    - Fixed an issue that prevented `Grafana` from starting by ensuring config persistence.
+
+## Fleet Management
+
+- **Kube Downscaler App** [v0.4.0](https://github.com/giantswarm/kube-downscaler-app/compare/v0.3.0...v0.4.0)
+    - Introduced a new `Cilium` network policy template for improved network management.
+
+## Security
+
+- **Kyverno Policies** [v0.21.1](https://github.com/giantswarm/kyverno-policies/compare/v0.21.0...v0.21.1)
+    - Enhanced visibility with the addition of the `application.giantswarm.io/team` label.
+
+- **Event Exporter App** [v2.0.0](https://github.com/giantswarm/event-exporter-app/compare/v1.0.0...v2.0.0)
+    - Transitioned to a new, supported image source for better stability and support.
diff --git a/src/content/getting-started/_index.md b/src/content/getting-started/_index.md
@@ -1,7 +1,10 @@
 ---
 title: Getting started
 description: Step-by-step customer journey to build your cloud-native developer platform.
-weight: 80
+menu:
+  principal:
+    identifier: getting-started
+weight: 20
 last_review_date: 2024-04-05
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/src/content/getting-started/prepare-your-provider-infrastructure/aws/_index.md b/src/content/getting-started/prepare-your-provider-infrastructure/aws/_index.md
@@ -1,8 +1,12 @@
 ---
 title: Prepare your AWS account
+linkTitle: AWS
 description: Prepare your AWS account to start building your cloud-native developer platform with Giant Swarm.
 weight: 10
 last_review_date: 2024-11-28
+menu:
+  principal:
+    parent: getting-started-prepare-provider-infrastructure
 owner:
   - https://github.com/orgs/giantswarm/teams/team-phoenix
 user_questions:

diff --git a/src/content/getting-started/prepare-your-provider-infrastructure/azure/_index.md b/src/content/getting-started/prepare-your-provider-infrastructure/azure/_index.md
@@ -1,9 +1,12 @@
 ---
 title: Prepare your provider account for Azure
-linkTitle: Prepare your Azure account
+linkTitle: Azure
 description: Prepare your Azure account to start building your cloud-native developer platform with Giant Swarm.
 weight: 20
 last_review_date: 2024-11-28
+menu:
+  principal:
+    parent: getting-started-prepare-provider-infrastructure
 owner:
   - https://github.com/orgs/giantswarm/teams/team-phoenix
 user_questions:

diff --git a/...ng-started/prepare-your-provider-infrastructure/vmware-cloud-director/_index.md b/...ng-started/prepare-your-provider-infrastructure/vmware-cloud-director/_index.md
@@ -1,9 +1,12 @@
 ---
 title: Prepare your provider environment for VMware Cloud Director
-linkTitle: Prepare your VCD environment
-description: Prepare your VMware Cloud Director setup to start building your cloud-native developer platform with Giant Swarm.
+linkTitle: VMware Cloud Director
+description: Prepare your VMware Cloud Director (VCD) setup to start building your cloud-native developer platform with Giant Swarm.
 weight: 30
 last_review_date: 2024-11-28
+menu:
+  principal:
+    parent: getting-started-prepare-provider-infrastructure
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs
 user_questions:

diff --git a/...t/getting-started/prepare-your-provider-infrastructure/vmware-vsphere/_index.md b/...t/getting-started/prepare-your-provider-infrastructure/vmware-vsphere/_index.md
@@ -1,9 +1,12 @@
 ---
 title: Prepare your provider environment for VMware vSphere
-linkTitle: Prepare your vSphere environment
+linkTitle: VMware vSphere
 description: Prepare your VMware vSphere setup to start building your cloud-native developer platform with Giant Swarm.
 weight: 40
 last_review_date: 2024-11-28
+menu:
+  principal:
+    parent: getting-started-prepare-provider-infrastructure
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs
 user_questions:

diff --git a/src/content/overview/_index.md b/src/content/overview/_index.md
@@ -1,7 +1,10 @@
 ---
 title: Overview
 description: Description of how our Cloud Native Developer Platform looks like and the services that Giant Swarm offer on top.
-weight: 100
+menu:
+  principal:
+    identifier: overview
+weight: 10
 last_review_date: 2024-03-07
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/src/content/overview/architecture/_index.md b/src/content/overview/architecture/_index.md
@@ -1,6 +1,6 @@
 ---
 title: Architecture of the Giant Swarm cloud-native developer platform
-linkTitle: Architecture of the platform
+linkTitle: Architecture
 description: Components, capabilities, supported cloud providers, and the platform API.
 weight: 20
 menu:

diff --git a/...iew/architecture/authentication/_index.md → ...view/architecture/authentication/index.md b/...iew/architecture/authentication/_index.md → ...view/architecture/authentication/index.md
diff --git a/src/content/overview/architecture/operational-layers/index.md b/src/content/overview/architecture/operational-layers/index.md
@@ -2,10 +2,11 @@
 linkTitle: Operational layers
 title: Giant Swarm operational layers
 description: Here you learn how the operational layers of Giant Swarm are defined and what the intended operational model is.
-weight: 20
+weight: 10
 menu:
-  main:
-    parent: platform-overview-security
+  principal:
+    parent: overview-architecture
+    identifier: overview-architecture-operational-layers
 last_review_date: 2024-12-04
 user_questions:
   - What are the Giant Swarm operational layers?

diff --git a/src/content/overview/connectivity/_index.md b/src/content/overview/connectivity/_index.md
@@ -1,5 +1,6 @@
 ---
 title: Connectivity
+linkTitle: Connectivity
 description: Public or private access to your workload applications through ingress. Secure connections between your distributed applications or microservices through a API gateway.
 weight: 70
 menu:

diff --git a/src/content/overview/fleet-management/_index.md b/src/content/overview/fleet-management/_index.md
@@ -5,7 +5,7 @@ weight: 40
 menu:
   principal:
     parent: overview
-    identifier: overview-fleet-management
+    identifier: overview-fleetmanagement
 last_review_date: 2024-06-03
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-product

diff --git a/src/content/overview/fleet-management/app-management/index.md b/src/content/overview/fleet-management/app-management/index.md
@@ -5,8 +5,8 @@ description: The app platform allows to manage app catalogs and apps, for simple
 weight: 40
 menu:
   principal:
-    parent: overview-fleet-management
-    identifier: overview-fleet-management-app-platform
+    parent: overview-fleetmanagement
+    identifier: overview-fleetmanagement-appmanagement
 owner:
   - https://github.com/orgs/giantswarm/teams/team-honeybadger
 user_questions:

diff --git a/src/content/overview/fleet-management/cluster-management/_index.md b/src/content/overview/fleet-management/cluster-management/_index.md
@@ -4,8 +4,8 @@ description: Supported cloud providers and management of clusters on the Giant S
 weight: 30
 menu:
   principal:
-    parent: overview-fleet-management
-    identifier: overview-fleet-management-clusters
+    parent: overview-fleetmanagement
+    identifier: overview-fleetmanagement-clustermanagement
 last_review_date: 2024-05-02
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-product

diff --git a/...content/overview/fleet-management/cluster-management/cluster-concepts/_index.md b/...content/overview/fleet-management/cluster-management/cluster-concepts/_index.md
@@ -1,11 +1,12 @@
 ---
 title: Main cluster concepts
+linkTitle: Concepts
 description: Overview of the main concepts of cluster management in the Giant Swarm platform.
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-clusters
-    identifier: overview-fleet-management-cluster-concepts
+    parent: overview-fleetmanagement-clustermanagement
+    identifier: overview-fleetmanagement-clustermanagement-concepts
 last_review_date: 2024-06-26
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/...-management/cluster-management/cluster-concepts/cluster-configuration/_index.md b/...-management/cluster-management/cluster-concepts/cluster-configuration/_index.md
@@ -4,8 +4,8 @@ description: Explanation of how cluster configuration works in Cluster API and h
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-cluster-concepts
-    identifier: overview-fleet-management-cluster-concepts-configuration
+    parent: overview-fleetmanagement-clustermanagement-concepts
+    identifier: overview-fleetmanagement-clustermanagement-concepts-configuration
 last_review_date: 2024-08-28
 owner:
   - https://github.com/orgs/giantswarm/teams/team-phoenix

diff --git a/...w/fleet-management/cluster-management/cluster-concepts/cluster-naming/_index.md b/...w/fleet-management/cluster-management/cluster-concepts/cluster-naming/_index.md
@@ -4,8 +4,8 @@ description: The specifications for naming workload clusters in the Giant Swarm
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-cluster-concepts
-    identifier: overview-fleet-management-cluster-concepts-naming
+    parent: overview-fleetmanagement-clustermanagement-concepts
+    identifier: overview-fleetmanagement-clustermanagement-concepts-naming
 last_review_date: 2024-06-14
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/...ew/fleet-management/cluster-management/cluster-concepts/multi-account/_index.md b/...ew/fleet-management/cluster-management/cluster-concepts/multi-account/_index.md
@@ -4,8 +4,8 @@ description: Learn the advantages of using multi-account clusters in the Giant S
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-cluster-concepts
-    identifier: overview-fleet-management-cluster-concepts-multi-account
+    parent: overview-fleetmanagement-clustermanagement-concepts
+    identifier: overview-fleetmanagement-clustermanagement-concepts-multiaccount
 last_review_date: 2024-07-14
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/...ew/fleet-management/cluster-management/cluster-concepts/organizations/_index.md b/...ew/fleet-management/cluster-management/cluster-concepts/organizations/_index.md
@@ -4,8 +4,8 @@ description: Organizations in the Giant Swarm platform allow isolation and logic
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-cluster-concepts
-    identifier: overview-fleet-management-cluster-concepts-organizations
+    parent: overview-fleetmanagement-clustermanagement-concepts
+    identifier: overview-fleetmanagement-clustermanagement-concepts-organizations
 last_review_date: 2024-07-14
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs

diff --git a/...fleet-management/cluster-management/cluster-concepts/private-clusters/_index.md b/...fleet-management/cluster-management/cluster-concepts/private-clusters/_index.md
@@ -4,8 +4,8 @@ description: Definition of what do we mean by private clusters in the Giant Swar
 weight: 10
 menu:
   principal:
-    parent: overview-fleet-management-cluster-concepts
-    identifier: overview-fleet-management-cluster-concepts-private
+    parent: overview-fleetmanagement-clustermanagement-concepts
+    identifier: overview-fleetmanagement-clustermanagement-concepts-private
 last_review_date: 2024-06-14
 owner:
   - https://github.com/orgs/giantswarm/teams/sig-docs