Skip to content

Commit

Permalink
Merge branch 'main' of github.com:giantswarm/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pipo02mix committed Dec 17, 2024
2 parents 07874d7 + c0dc945 commit 3ca4463
Show file tree
Hide file tree
Showing 80 changed files with 1,030 additions and 8,851 deletions.
20 changes: 20 additions & 0 deletions .github/workflows/check-update-crd-reference.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Validates the configuration for the CRD reference update script
# in scripts/update-crd-reference

name: check-update-crd-reference

on:
push:
paths:
- scripts/update-crd-reference/*

jobs:
check:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Validate configuration
run: |
make update-crd-reference
5 changes: 2 additions & 3 deletions .github/workflows/generate-review-issues.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
name: Generate review Issues weekly
on:
schedule:
# At 0:00 on Sundays
- cron: '0 0 * * 0'

# At 0:05 on Sundays
- cron: '5 0 * * 0'

jobs:
front-matter:
Expand Down
40 changes: 40 additions & 0 deletions .github/workflows/validate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,46 @@ jobs:
exit 1
fi
- name: Check file and folder names in content
shell: python {0}
run: |
# Walk content folder, check file names to use only allowed characters
from pathlib import Path
import re
import os
import sys
allowed_chars = re.compile(r'^[a-z0-9-\.+]+$')
allowed_chars_static = re.compile(r'^[a-z0-9-\._]+$') # images etc. may use the underscore
content_dir = 'src/content'
errors = []
for root, dirs, files in os.walk(content_dir):
for file in files:
full_path = Path(root, file)
if full_path.name == '_index.md':
continue
if full_path.name == '_template.md.tpl':
continue
if full_path.suffix.lower() == '.md':
if not allowed_chars.match(full_path.stem):
errors.append(f"- FILE {full_path}")
else:
# static files
if not allowed_chars_static.match(full_path.name):
errors.append(f"- FILE {full_path}")
for dir in dirs:
if not allowed_chars.match(dir):
errors.append(f"- DIR {Path(root, dir)}")
if len(errors) > 0:
sys.stderr.write("The following file/folder names use invalid characters. Only lowercase letters, digits, hyphens and period are allowed.\n")
for error in errors:
sys.stderr.write(error + "\n")
sys.exit(1)
- name: Check for moved or deleted files
run: |
git --no-pager diff --name-status --diff-filter=RD "refs/heads/${GITHUB_BASE_REF}" -- . | tee files.txt
Expand Down
10 changes: 3 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,6 @@ export-csv:
$(REGISTRY)/$(COMPANY)/docs-scriptrunner:latest \
/workdir/scripts/export-csv/script.py

# Update content from external repositories that gets copied in here.
update-external-repos:
./scripts/update-external-repos/main.sh

# Aggregate changelog entries from various repositories into our Changes section.
changes:
@if [ -z "${GITHUB_TOKEN}" ]; then echo "Please set the GITHUB_TOKEN environment variable"; exit 1; fi
Expand Down Expand Up @@ -58,7 +54,6 @@ update-cluster-app-reference:
# Generate the reference documentation for the custom resource
# definitions (CRD) used in the Management API.
update-crd-reference:
scripts/update-crd-reference/update_config.sh
scripts/update-crd-reference/main.sh

lint: lint-markdown lint-prose validate-front-matter
Expand Down Expand Up @@ -114,13 +109,14 @@ validate-front-matter:
$(REGISTRY)/$(COMPANY)/docs-scriptrunner:latest \
/workdir/scripts/validate-front-matter/script.py

# Validate front matter in all pages.
# Validate front matter for last-reviewed date.
validate-last-reviewed:
docker run --rm \
--volume=${PWD}:/workdir:ro \
-w /workdir \
$(REGISTRY)/$(COMPANY)/docs-scriptrunner:latest \
/workdir/scripts/validate-front-matter/script.py --validation last-reviewed \
/workdir/scripts/validate-front-matter/script.py \
--validation last-reviewed \
--output json

# Print a report of pages with a last_review_date that's
Expand Down
11 changes: 11 additions & 0 deletions renovate.json5
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,16 @@
],
versioningTemplate: '{{#if versioning}}{{{versioning}}}{{else}}semver{{/if}}',
},
// Detect CRD source versions
{
customType: 'regex',
datasourceTemplate: 'github-tags',
fileMatch: ['^scripts/update-crd-reference/config\\.yaml$'],
matchStrings: [
'short_name:\\s*(?<depName>?)\\s+commit_reference:\\s*(?<currentValue>\\S+)',
],
packageNameTemplate: 'giantswarm/{{{depName}}}',
versioningTemplate: 'semver-coerced',
},
],
}
43 changes: 0 additions & 43 deletions scripts/update-crd-reference/update_config.sh

This file was deleted.

49 changes: 0 additions & 49 deletions scripts/update-external-repos/main.sh

This file was deleted.

1 change: 0 additions & 1 deletion scripts/update-external-repos/repositories.txt

This file was deleted.

30 changes: 3 additions & 27 deletions scripts/update-helm-chart-reference/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,42 +29,18 @@ source_repositories:
- url: https://github.com/giantswarm/cluster-vsphere
organization: giantswarm
introduction: |
The `default-apps-vsphere` chart templates all the VMware infrastructure resources that are necessary to create a Cluster API vSphere cluster.
The `cluster-vsphere` chart templates all the VMware infrastructure resources that are necessary to create a Cluster API vSphere cluster.
name: cluster-vsphere
commit_reference: v0.9.8
- url: https://github.com/giantswarm/cluster-cloud-director
organization: giantswarm
introduction: |
The `default-apps-cloud-director` chart templates all the VMware infrastructure resources that are necessary to create a Cluster API VCD cluster.
The `cluster-cloud-director` chart templates all the VMware infrastructure resources that are necessary to create a Cluster API VCD cluster.
name: cluster-cloud-director
commit_reference: v0.14.2
- url: https://github.com/giantswarm/default-apps-aws
organization: giantswarm
introduction: |
The `default-apps-aws` chart templates all the components required for a Cluster API AWS cluster like External DNS or CoreDNS.
name: default-apps-aws
commit_reference: v0.48.0
- url: https://github.com/giantswarm/default-apps-eks
organization: giantswarm
introduction: |
The `default-apps-eks` chart templates all the components required for a Cluster API EKS cluster like External DNS or CoreDNS.
The `default-apps-eks` chart templates all the standard apps deployed to AWS EKS clusters, like External DNS and CoreDNS.
name: default-apps-eks
commit_reference: v0.5.1
- url: https://github.com/giantswarm/default-apps-azure
organization: giantswarm
introduction: |
The `default-apps-azure` chart templates all the components required for a Cluster API Azure cluster like External DNS or CoreDNS.
name: default-apps-azure
commit_reference: v0.8.3
- url: https://github.com/giantswarm/default-apps-vsphere
organization: giantswarm
introduction: |
The `default-apps-vsphere` chart templates all the components required for a Cluster API VMware cluster like External DNS or CoreDNS.
name: default-apps-vsphere
commit_reference: v0.12.1
- url: https://github.com/giantswarm/default-apps-cloud-director
organization: giantswarm
introduction: |
The `default-apps-cloud-director` chart templates all the components required for a Cluster API VMware cluster like External DNS or CoreDNS.
name: default-apps-cloud-director
commit_reference: v0.7.3
19 changes: 19 additions & 0 deletions src/content/changes/web-ui/backstage/v0.45.3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
# Generated by scripts/aggregate-changelogs. WARNING: Manual edits to this files will be overwritten.
changes_categories:
- Web UI
changes_entry:
repository: giantswarm/backstage
url: https://github.com/giantswarm/backstage/blob/master/CHANGELOG.md#0453---2024-12-16
version: 0.45.3
version_tag: v0.45.3
date: '2024-12-16T09:39:06'
description: Changelog entry for giantswarm/backstage version 0.45.3, published on
16 December 2024, 09:39.
title: backstage release v0.45.3
---

In this release:
- GS OIDC auth provider sign-in resolver was changed to correctly handle Azure AD identity provider;
- user reference used in telemetry signals now contains unique hash for guest users.
See [./docs/releases/v0.45.3-changelog.md](./docs/releases/v0.45.3-changelog.md) for more information.
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
# Generated by scripts/aggregate-changelogs. WARNING: Manual edits to this files will be overwritten.
aliases:
- /changes/tenant-cluster-releases-azure/releases/azure-azure-29.4.0/
changes_categories:
- Workload cluster releases for Azure
changes_entry:
repository: giantswarm/releases
url: https://github.com/giantswarm/releases/tree/master/azure/v29.4.0
version: azure-29.4.0
version_tag: azure-29.4.0
date: '2024-12-12T12:00:00'
description: Release notes for Azure workload cluster release azure-29.4.0, published
on 12 December 2024, 12:00.
title: Workload cluster release azure-29.4.0 for Azure
---

## Changes compared to v29.3.0

### Components

- cluster-azure from v1.4.0 to v1.5.0
- Kubernetes from v1.29.10 to [v1.29.12](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.29.md#changelog-since-v12910)

### cluster-azure [v1.4.0...v1.5.0](https://github.com/giantswarm/cluster-azure/compare/v1.4.0...v1.5.0)

#### Changed

- Chart: Update `cluster` to [v1.7.0](https://github.com/giantswarm/cluster/releases/tag/v1.7.0).
- Add `teleport-init` systemd unit to handle initial token setup before `teleport` service starts
- Improve `teleport` service reliability by adding proper file and service dependencies and pre-start checks

### Apps

- cert-manager from v3.8.1 to v3.8.2
- coredns from v1.22.0 to v1.23.0
- observability-bundle from v1.8.0 to v1.9.0

### cert-manager [v3.8.1...v3.8.2](https://github.com/giantswarm/cert-manager-app/compare/v3.8.1...v3.8.2)

#### Changed

- Changed ownership to team Shield

#### Removed

- Get rid of label `giantswarm.io/monitoring_basic_sli` as this slo generation label is not used anymore.

### coredns [v1.22.0...v1.23.0](https://github.com/giantswarm/coredns-app/compare/v1.22.0...v1.23.0)

#### Changed

- Update `coredns` image to [1.11.4](https://github.com/coredns/coredns/releases/tag/v1.11.4).
- Explicitly expose liveness and readiness probe ports in deployments.

#### Removed

- Remove PodSecurityPolicy and associated Resources and values.

### observability-bundle [v1.8.0...v1.9.0](https://github.com/giantswarm/observability-bundle/compare/v1.8.0...v1.9.0)

#### Added

- Add `alloy` v0.7.0 as `alloyEvents`.

#### Changed

- Upgrade `alloy-logs` and `alloy-metrics` to chart 0.7.0.
- Bumps `alloy` from 1.4.2 to 1.5.0
- upgrade `kube-prometheus-stack` from 65.1.1 to 66.2.1
- prometheus-operator CRDs from 0.75.0 to 0.78.1
- prometheus-operator from 0.77.1 to 0.78.1
- prometheus from 2.54.1 to 2.55.1
- kube-state-metrics from 2.13.0 to 2.14.0
- grafana from 8.5.0 to 8.6.0
Loading

0 comments on commit 3ca4463

Please sign in to comment.