Skip to content

Commit e240d4b

Browse files
authored
docs(operator): documentation rework (#1184)
- Deleted the "Advanced Configuration" section from the operator docs - Cleaned up references to deprecated configuration patterns
1 parent 29b5b52 commit e240d4b

63 files changed

Lines changed: 3040 additions & 2295 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/docs-test.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ jobs:
2525

2626
- name: Install Dependencies
2727
working-directory: docs
28+
env:
29+
NPM_CONFIG_USERCONFIG: ${{ github.workspace }}/.npmrc
2830
run: npm ci
2931

3032
- name: Build Docusaurus

.github/workflows/dotnet-pre-release.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ jobs:
4141
cache-dependency-path: .release/package-lock.json
4242

4343
- name: Setup Semantic Release
44+
env:
45+
NPM_CONFIG_USERCONFIG: ${{ github.workspace }}/.npmrc
4446
run: |
4547
# --ignore-scripts blocks all dependencies' lifecycle scripts; the one
4648
# patch we need is then applied explicitly via patch-package.

.github/workflows/dotnet-release.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ jobs:
4040
cache-dependency-path: .release/package-lock.json
4141

4242
- name: Setup Semantic Release
43+
env:
44+
NPM_CONFIG_USERCONFIG: ${{ github.workspace }}/.npmrc
4345
run: |
4446
# --ignore-scripts blocks all dependencies' lifecycle scripts; the one
4547
# patch we need is then applied explicitly via patch-package.

.github/workflows/gh-pages.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ jobs:
3434

3535
- name: Install Dependencies
3636
working-directory: docs
37+
env:
38+
NPM_CONFIG_USERCONFIG: ${{ github.workspace }}/.npmrc
3739
run: npm ci
3840

3941
- name: Build Docusaurus

.npmrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Repo-wide npm registry policy. Workflows pass this file explicitly.
2+
registry=https://registry.npmjs.org/

.release/.npmrc

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/docs/operator/advanced-configuration.mdx

Lines changed: 0 additions & 1072 deletions
This file was deleted.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"position": 15,
3+
"label": ".NET Aspire",
4+
"collapsible": true,
5+
"collapsed": true
6+
}
Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: .NET Aspire
33
description: Orchestrate and observe a KubeOps operator with .NET Aspire
4-
sidebar_position: 9.5
54
---
65

76
# .NET Aspire Integration
@@ -10,8 +9,8 @@ sidebar_position: 9.5
109

1110
| Package | Side | Purpose |
1211
| --- | --- | --- |
13-
| [`KubeOps.Aspire.Hosting`](../packages/aspire-hosting) | AppHost | Adds `AddKubeOps<TProject>(...)` so the operator is orchestrated as a resource. |
14-
| [`KubeOps.Aspire`](../packages/aspire) | Operator | Adds `AddKubeOpsServiceDefaults()` for OpenTelemetry, service discovery, resilience and health checks. |
12+
| [`KubeOps.Aspire.Hosting`](../../packages/aspire-hosting) | AppHost | Adds `AddKubeOps<TProject>(...)` so the operator is orchestrated as a resource. |
13+
| [`KubeOps.Aspire`](../../packages/aspire) | Operator | Adds `AddKubeOpsServiceDefaults()` for OpenTelemetry, service discovery, resilience and health checks. |
1514

1615
Together they give you a local dashboard with the operator's logs, traces and metrics, automatic service discovery to other resources, and a single entry point to run, publish, or deploy the whole stack.
1716

@@ -48,7 +47,7 @@ await host.RunAsync();
4847

4948
`AddKubeOpsServiceDefaults()` configures:
5049

51-
- **OpenTelemetry** logging (with scopes and formatted messages), metrics (runtime + `HttpClient`) and tracing. It subscribes to the operator's `ActivitySource`, which KubeOps registers under the operator name (see [Logging, Tracing, and OpenTelemetry](./logging)).
50+
- **OpenTelemetry** logging (with scopes and formatted messages), metrics (runtime + `HttpClient`) and tracing. It subscribes to the operator's `ActivitySource`, which KubeOps registers under the operator name (see [Logging, Tracing, and OpenTelemetry](../observability/logging)).
5251
- **OTLP export** &mdash; enabled automatically when the `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable is present. Aspire sets this for you, so traces and metrics show up in the dashboard with no extra code.
5352
- **Service discovery** &mdash; `HttpClient` instances resolve logical Aspire resource names (e.g. `https://apiservice`).
5453
- **HTTP resilience** &mdash; the standard resilience handler (retries, circuit breaker, timeouts) is applied to all `HttpClient` instances.
@@ -142,7 +141,7 @@ The operator process runs locally and authenticates through the selected Kuberne
142141

143142
`KubeOps.Aspire` is usable from a plain console operator and therefore does **not** force an ASP.NET Core dependency. The default health checks are registered in the service collection, but exposing them over HTTP requires an HTTP server.
144143

145-
If your operator already hosts webhooks via [`KubeOps.Operator.Web`](../packages/operator-web), map the endpoints on the `WebApplication`:
144+
If your operator already hosts webhooks via [`KubeOps.Operator.Web`](../../packages/operator-web), map the endpoints on the `WebApplication`:
146145

147146
```csharp
148147
app.MapHealthChecks("/health");
@@ -244,4 +243,4 @@ builder.AddKubeOps<Projects.AspireOperator>("operator")
244243
.PublishAsKubernetesOperator(aks, publish => publish.WithServiceAccount("operator"));
245244
```
246245

247-
For the deeper run/publish model, see [Aspire Kubernetes Operator Model](./aspire-kubernetes-model).
246+
For the deeper run/publish model, see [Aspire Kubernetes Operator Model](./kubernetes-operator-model).

docs/docs/operator/aspire-kubernetes-model.mdx renamed to docs/docs/operator/aspire/kubernetes-operator-model.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Aspire Kubernetes Operator Model
33
description: Run, publish, and deploy KubeOps operators with Aspire Kubernetes environments.
4-
sidebar_position: 12
4+
sidebar_position: 1
55
---
66

77
# Aspire Kubernetes Operator Model

0 commit comments

Comments
 (0)