Admin overview config overviews #6482

iRaindrop · 2025-10-30T18:42:33Z

The overview of configuration tasks should parallell the Navigation.

Proposed Changes

Reformatted listing
Added mermaid graphic for testing

Added mermaid graphic and content formatting testing

netlify · 2025-10-30T18:42:39Z

✅ Deploy Preview for knative ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`27b23a5`
🔍 Latest deploy log	https://app.netlify.com/projects/knative/deploys/690503168f335700089e3260
😎 Deploy Preview	https://deploy-preview-6482--knative.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

knative-prow · 2025-10-30T18:42:41Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: iRaindrop
Once this PR has been reviewed and has the lgtm label, please assign houshengbo for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Formatting testing

Trying a "blog" approach....

Minor edits

Link fixes

Minor edits

evankanderson · 2025-10-31T05:13:51Z

docs/versioned/admin/admin-overview.md

+```mermaid
+---
+config:
+  theme: redux
+---
+flowchart TD
+    A(["Administrator"]) --> B{"Knative"}
+    B --> C["Knative Serving"] & D["Knative Eventing"]


This doesn't exactly match what I was imagining for the "duck analogy" (which doesn't seem to show up in the text).

I was thinking of something more like:

Suggested change

```mermaid

---

config:

theme: redux

---

flowchart TD

A(["Administrator"]) --> B{"Knative"}

B --> C["Knative Serving"] & D["Knative Eventing"]

```mermaid

---

config:

theme: redux

---

flowchart TD

Dev(["Application Developers"])

dev-acts@{ shape: text, label: "Manages k8s objects defined by" }

subgraph Knative

Serving

Eventing

end

subgraph Plugins

net-istio["Istio"]

net-contour["Contour"]

net-gateway-api["Gateway API"]

event-kafka["Kafka"]

event-rabbitmq["RabbitMQ"]

event-nats["NATS"]

end

event-impl@{ shape: text, label: "implements" }

net-impl@{ shape: text, label: "implements" }

admin-acts@{ shape: text, label: "Installs and configures" }

Admin(["Cluster Administrators"])

Dev --- dev-acts

dev-acts --> Serving & Eventing

admin-acts --- Admin

Plugins & Knative --- admin-acts

%% The ~~~ ... --> syntax is used to force backwards arrows;

%% See https://github.com/mermaid-js/mermaid/issues/2629 for details.

Serving ~~~ net-impl --> Serving

Eventing ~~~ event-impl --> Eventing

net-impl --- net-istio & net-contour & net-gateway-api

event-impl --- event-kafka & event-rabbitmq & event-nats

For the links around event-impl and net-impl, you might want to use the -.- or -.-> syntax to make the lines dotted rather than solid

Thanks - That was just a placeholder -- looks great

evankanderson · 2025-10-31T05:16:45Z

docs/versioned/admin/admin-overview.md

 Knative uses Kubernetes YAML manifests to define and configure system components. These manifests include core resources, custom resource definitions (CRDs), and extensibility features. As with Kubernetes, these configuration resources are declarative and can be managed using the `kubectl` CLI tool or with continuous delivery tools.

-### Resource scoping and namespaces
+The following sections provide an overview of the current configurations procedures of interest to Administrators.


I'm still not entirely sold on duplicating the navigation in prose here. I realize that it's tempting to have a little more explanation than what's in the titles in the left-hand navigation, but I have a maintenance concern that duplicating the navigation here will cause the two to drift out of sync over time.

Yeah, even thought it's at the node level. The Eventing config overviews fell nicely into a table, I can redo for Serving and Network Options into a table.

Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

Added Eventing config summaries

Put all config overviews in tables

Section title tweaks

Formatting edits

Organized sections

Formatting test

Removed temporary test

Section organization

Title shortening

Alphabetized rows in config summary tables

Link text edits in tables first columns

Minor edit to rebuild

evankanderson · 2025-10-31T21:45:35Z

docs/versioned/admin/admin-overview.md


 This page provides guidance for administrators on how to manage Knative on an existing Kubernetes cluster.

+```mermaid


I think we need at least a sentence or two of explanation before just dropping the diagram on folks. (Particularly since it's a fairly big diagram.)

I think some color-coding would help substantially -- I'd suggest different colors for:

Actors (developers and administrators)

Developer-facing abstractions (Serving & Eventing)

Make the "action" blocks have a transparent background when rendered.

evankanderson · 2025-10-31T21:46:00Z

docs/versioned/admin/admin-overview.md

 Of particular interest to cluster administrators is that Knative supports customizable _default values_ on the parameters defined in resource YAML files. These configurations reduce the amount of environment configuration tasks developers needs to consider.

-## Knative installations
+## Installations


Why are these titles plural?

evankanderson · 2025-10-31T21:47:37Z

docs/versioned/admin/admin-overview.md

-## Knative installations
+## Installations

 See the [Installation roadmap](../install/README.md#installation-roadmap) for prerequisites and installation steps. Your first installation decision is whether to use a YAML-based installation or use the Knative Operator. The Knative Operator is a custom controller that extends the Kubernetes API to install Knative components. If you just need to get acquainted with Knative at this time, you can install the [quickstart](../getting-started/quickstart-install.md).


It feels like a second paragraph here providing information about how permanent these choices are (answer: it's possible to change live, but not documented or guaranteed to work, so probably safer to set up a new cluster if changing that choice.)

evankanderson · 2025-10-31T21:49:30Z

docs/versioned/admin/admin-overview.md

 - Using the Knative Operator

-    Some platform-wide settings can be managed declaratively using the Knative Operator.
+    Some platform-wide settings can be managed declaratively using the Knative Operator, installed with the `kn` Knative CLI plugin. For more information, see [Installing CLI tools](../client/README.md)


The operator can be managed with our without the kn CLI. However, the kn CLI really only works to manage operator installations, not the other options.

Update admin-overview.md

86844ee

Added mermaid graphic and content formatting testing

knative-prow bot requested review from nainaz and skonto October 30, 2025 18:42

knative-prow bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 30, 2025

iRaindrop marked this pull request as draft October 30, 2025 18:43

knative-prow bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 30, 2025

iRaindrop added 5 commits October 30, 2025 12:20

Update admin-overview.md

ee353b9

Formatting testing

Update admin-overview.md

39f98bd

Trying a "blog" approach....

Update admin-overview.md

a975f5c

Minor edits

Update admin-overview.md

4d519f9

Link fixes

Update admin-overview.md

5b77048

Minor edits

evankanderson reviewed Oct 31, 2025

View reviewed changes

Update docs/versioned/admin/admin-overview.md

d09b0f3

Co-authored-by: Evan Anderson <evan.k.anderson@gmail.com>

knative-prow bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 31, 2025

iRaindrop added 12 commits October 30, 2025 23:13

Update admin-overview.md

500ac2f

Added Eventing config summaries

Update admin-overview.md

4464b7a

Put all config overviews in tables

Update admin-overview.md

3654642

Section title tweaks

Update admin-overview.md

2631259

Formatting edits

Update admin-overview.md

bc3125a

Organized sections

Update admin-overview.md

bc743bf

Formatting test

Update admin-overview.md

efa3f03

Removed temporary test

Update admin-overview.md

d6e0422

Section organization

Update admin-overview.md

7404d61

Title shortening

Update admin-overview.md

727fffe

Alphabetized rows in config summary tables

Update admin-overview.md

b8a0223

Link text edits in tables first columns

Update admin-overview.md

27b23a5

Minor edit to rebuild

evankanderson reviewed Oct 31, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Admin overview config overviews #6482

Admin overview config overviews #6482

iRaindrop commented Oct 30, 2025

Uh oh!

netlify bot commented Oct 30, 2025 •

edited

Loading

Uh oh!

knative-prow bot commented Oct 30, 2025

Uh oh!

evankanderson Oct 31, 2025

Uh oh!

evankanderson Oct 31, 2025

Uh oh!

iRaindrop Oct 31, 2025 •

edited

Loading

Uh oh!

evankanderson Oct 31, 2025

Uh oh!

iRaindrop Oct 31, 2025

Uh oh!

evankanderson Oct 31, 2025

Uh oh!

evankanderson Oct 31, 2025

Uh oh!

evankanderson Oct 31, 2025

Uh oh!

evankanderson Oct 31, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-```mermaid
----
-config:
-  theme: redux
----
-flowchart TD
-    A(["Administrator"]) --> B{"Knative"}
-    B --> C["Knative Serving"] & D["Knative Eventing"]
+```mermaid
+---
+config:
+  theme: redux
+---
+flowchart TD
+    Dev(["Application Developers"])
+    dev-acts@{ shape: text, label: "Manages k8s objects defined by" }
+    subgraph Knative
+        Serving
+        Eventing
+    end
+    subgraph Plugins
+        net-istio["Istio"]
+        net-contour["Contour"]
+        net-gateway-api["Gateway API"]
+        event-kafka["Kafka"]
+        event-rabbitmq["RabbitMQ"]
+        event-nats["NATS"]
+    end
+    event-impl@{ shape: text, label: "implements" }
+    net-impl@{ shape: text, label: "implements" }
+    admin-acts@{ shape: text, label: "Installs and configures" }
+    Admin(["Cluster Administrators"])
+    Dev --- dev-acts
+    dev-acts --> Serving & Eventing
+    admin-acts --- Admin
+    Plugins & Knative --- admin-acts
+    %% The ~~~ ... --> syntax is used to force backwards arrows;
+    %% See https://github.com/mermaid-js/mermaid/issues/2629 for details.
+    Serving ~~~ net-impl --> Serving
+    Eventing ~~~ event-impl --> Eventing
+    net-impl --- net-istio & net-contour & net-gateway-api
+    event-impl --- event-kafka & event-rabbitmq & event-nats


		This page provides guidance for administrators on how to manage Knative on an existing Kubernetes cluster.

		```mermaid

Admin overview config overviews #6482

Are you sure you want to change the base?

Admin overview config overviews #6482

Conversation

iRaindrop commented Oct 30, 2025

Proposed Changes

Uh oh!

netlify bot commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for knative ready!

Uh oh!

knative-prow bot commented Oct 30, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iRaindrop Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify bot commented Oct 30, 2025 •

edited

Loading

iRaindrop Oct 31, 2025 •

edited

Loading