Skip to content

Commit cfa8564

Browse files
Re-arrange navigation to fill out 'Administration' topic (#6430)
Co-authored-by: Evan Anderson <[email protected]>
1 parent f5a6072 commit cfa8564

File tree

7 files changed

+326
-393
lines changed

7 files changed

+326
-393
lines changed

docs/versioned/.nav.yml

Lines changed: 95 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,7 @@ nav:
6060
- Overview: serving/README.md
6161
- Architecture: serving/architecture.md
6262
- Request Flow: serving/request-flow.md
63-
- Resources:
64-
- Revisions:
65-
- About Revisions: serving/revisions/README.md
66-
- Administrator configuration options: serving/revisions/revision-admin-config-options.md
67-
- Developer configuration options: serving/revisions/revision-developer-config-options.md
68-
# add other resource types
63+
- Converting a Kubernetes Deployment to a Knative Service: serving/convert-deployment-to-knative-service.md
6964
- Autoscaling:
7065
- About autoscaling: serving/autoscaling/README.md
7166
- Supported autoscaler types: serving/autoscaling/autoscaler-types.md
@@ -94,6 +89,9 @@ nav:
9489
- Configuring HTTP: serving/services/http-protocol.md
9590
- Performing Dry Run: serving/dryrun.md
9691
- Volume Support: serving/services/storage.md
92+
- Revisions:
93+
- About Revisions: serving/revisions/README.md
94+
- Garbage Collection: serving/revisions/revision-developer-config-options.md
9795
- Traffic management: serving/traffic-management.md
9896
- Configuring gradual rollout of traffic to Revisions: serving/rolling-out-latest-revision.md
9997
- Tag resolution: serving/tag-resolution.md
@@ -102,27 +100,6 @@ nav:
102100
- About load balancing: serving/load-balancing/README.md
103101
- Configuring target burst capacity: serving/load-balancing/target-burst-capacity.md
104102
- Configuring Activator capacity: serving/load-balancing/activator-capacity.md
105-
# Serving - admin docs
106-
- Administrator Topics:
107-
- Kubernetes services: serving/knative-kubernetes-services.md
108-
- Enabling requests to Knative services when additional authorization policies are enabled: serving/istio-authorization.md
109-
- Exclude namespaces from the Knative webhook: serving/webhook-customizations.md
110-
- Configuring high-availability components: serving/config-ha.md
111-
- Configuring the ingress gateway: serving/setting-up-custom-ingress-gateway.md
112-
- Configuring domain names: serving/using-a-custom-domain.md
113-
- Converting a Kubernetes Deployment to a Knative Service: serving/convert-deployment-to-knative-service.md
114-
- Extending Queue Proxy image with QPOptions: serving/queue-extensions.md
115-
- Serving configuration:
116-
- Configure Deployment resources: serving/configuration/deployment.md
117-
- Configuring gradual rollout of traffic to Revisions: serving/configuration/rolling-out-latest-revision-configmap.md
118-
- Feature and extension flags: serving/configuration/feature-flags.md
119-
- Configure the Defaults ConfigMap: serving/configuration/config-defaults.md
120-
- Serving encryption configuration:
121-
- Overview: serving/encryption/encryption-overview.md
122-
- Configure cert-manager integration: serving/encryption/configure-certmanager-integration.md
123-
- Configure external domain encryption: serving/encryption/external-domain-tls.md
124-
- Configure cluster-local domain encryption: serving/encryption/cluster-local-domain-tls.md
125-
- Configure Knative system-internal encryption: serving/encryption/system-internal-tls.md
126103
# Serving - Application Security
127104
- Application security:
128105
- About Security-Guard: serving/app-security/security-guard-about.md
@@ -131,10 +108,6 @@ nav:
131108
- Security-Guard example alerts: serving/app-security/security-guard-example-alerts.md
132109
# Serving - observability
133110
- Observability:
134-
- Request traces: serving/observability/accessing-traces.md
135-
- Collecting logs: serving/observability/logging/collecting-logs.md
136-
- Configuring logging: serving/observability/logging/config-logging.md
137-
- Configuring Request logging: serving/observability/logging/request-logging.md
138111
- Collecting metrics: serving/observability/metrics/collecting-metrics.md
139112
- Metrics Reference: serving/observability/metrics/serving-metrics.md
140113
# Serving - troubleshooting
@@ -158,7 +131,6 @@ nav:
158131
- Channel based Broker: eventing/brokers/broker-types/channel-based-broker/README.md
159132
- Apache Kafka:
160133
- About Apache Kafka Broker: eventing/brokers/broker-types/kafka-broker/README.md
161-
- Configuring Kafka features: eventing/brokers/broker-types/kafka-broker/configuring-kafka-features.md
162134
- RabbitMQ Broker: eventing/brokers/broker-types/rabbitmq-broker/README.md
163135
- Creating a Broker: eventing/brokers/create-broker.md
164136
- Developer configuration options: eventing/brokers/broker-developer-config-options.md
@@ -241,35 +213,10 @@ nav:
241213
- Knative EventMesh Backstage Plugin: eventing/event-registry/eventmesh-backstage-plugin.md
242214
- Sugar controller: eventing/sugar/README.md
243215
- Debugging: eventing/troubleshooting/README.md
244-
- Administrator topics:
245-
# Eventing config
246-
- Eventing configuration:
247-
- Configure Broker defaults: eventing/configuration/broker-configuration.md
248-
- Configure Channel defaults: eventing/configuration/channel-configuration.md
249-
- Configure Apache Kafka Channel defaults: eventing/configuration/kafka-channel-configuration.md
250-
- Configure event source defaults: eventing/configuration/sources-configuration.md
251-
- Configure Sugar Controller: eventing/configuration/sugar-configuration.md
252-
- Configure KEDA Autoscaling of Knative Kafka Resources: eventing/configuration/keda-configuration.md
253216
# Eventing - observability
254217
- Observability:
255-
- Accessing CloudEvent traces: eventing/observability/accessing-traces.md
256-
- Collecting logs: eventing/observability/logging/collecting-logs.md
257-
- Configuring logging: eventing/observability/logging/config-logging.md
258218
- Collecting metrics: eventing/observability/metrics/collecting-metrics.md
259219
- Metrics Reference: eventing/observability/metrics/eventing-metrics.md
260-
- Features:
261-
- About Eventing features: eventing/features/README.md
262-
- DeliverySpec.Timeout field: eventing/features/delivery-timeout.md
263-
- DeliverySpec.RetryAfterMax field: eventing/features/delivery-retryafter.md
264-
- New APIServerSource Filters: eventing/features/new-apiserversource-filters.md
265-
- KReference.Group field: eventing/features/kreference-group.md
266-
- Knative reference mapping: eventing/features/kreference-mapping.md
267-
- EventType auto creation: eventing/features/eventtype-auto-creation.md
268-
- Transport Encryption: eventing/features/transport-encryption.md
269-
- Sender Identity: eventing/features/sender-identity.md
270-
- Authorization: eventing/features/authorization.md
271-
- Eventing with Istio: eventing/features/istio-integration.md
272-
- Cross Namespace Event Links: eventing/features/cross-namespace-event-links.md
273220
- FAQ: eventing/faq/README.md
274221
# Eventing reference docs
275222
- Reference:
@@ -286,42 +233,101 @@ nav:
286233
# Administration
287234
###############################################################################
288235
- Administration:
289-
# TODO: add a general overview of Knative for administrators
290-
- Installing Knative: install/README.md
291-
# YAML Installation
292-
- Install Knative with YAML:
293-
- About YAML-based installation: install/yaml-install/README.md
294-
- Install Knative Serving:
295-
- Install Serving with YAML: install/yaml-install/serving/install-serving-with-yaml.md
296-
- Knative Serving installation files: install/yaml-install/serving/serving-installation-files.md
297-
- Install Knative Eventing:
298-
- Install Eventing with YAML: install/yaml-install/eventing/install-eventing-with-yaml.md
299-
- Knative Eventing installation files: install/yaml-install/eventing/eventing-installation-files.md
300-
# Operator Installation
301-
- Install with Knative Operator:
302-
- Install by using the Knative Operator: install/operator/knative-with-operators.md
303-
- Install by using the Knative Operator CLI plugin: install/operator/knative-with-operator-cli.md
304-
- Configuring Knative using the Operator: install/operator/configuring-with-operator.md
305-
- Configuring Knative Serving CRDs: install/operator/configuring-serving-cr.md
306-
- Configuring Knative Eventing CRDs: install/operator/configuring-eventing-cr.md
307-
# Advanced options for Serving
308-
- Install advanced options:
309-
# Istio Installation
310-
- Install Istio for Knative: install/installing-istio.md
311-
# Cert-manager Installation
312-
- Install cert-manager: install/installing-cert-manager.md
313-
# Backstage plugin
314-
- Install Knative Backstage plugin: install/installing-backstage-plugins.md
315-
# Vendor docs
316-
- Using a Knative-based offering: install/knative-offerings.md
236+
- Overview: administer/README.md
237+
- Installing Knative:
238+
- Overview: install/README.md
239+
# YAML Installation
240+
- Install Knative with YAML:
241+
- About YAML-based installation: install/yaml-install/README.md
242+
- Install Knative Serving:
243+
- Install Serving with YAML: install/yaml-install/serving/install-serving-with-yaml.md
244+
- Knative Serving installation files: install/yaml-install/serving/serving-installation-files.md
245+
- Install Knative Eventing:
246+
- Install Eventing with YAML: install/yaml-install/eventing/install-eventing-with-yaml.md
247+
- Knative Eventing installation files: install/yaml-install/eventing/eventing-installation-files.md
248+
# Operator Installation
249+
- Install with Knative Operator:
250+
- Install by using the Knative Operator: install/operator/knative-with-operators.md
251+
- Install by using the Knative Operator CLI plugin: install/operator/knative-with-operator-cli.md
252+
- Configuring Knative using the Operator: install/operator/configuring-with-operator.md
253+
- Configuring Knative Serving CRDs: install/operator/configuring-serving-cr.md
254+
- Configuring Knative Eventing CRDs: install/operator/configuring-eventing-cr.md
255+
- Installing plugins:
256+
- Install Istio for Knative: install/installing-istio.md
257+
# TODO: docs for kourier, contour, gateway-api
258+
- Install Kafka for Knative: install/eventing/kafka-install.md
259+
- Install RabbitMQ for Knative: install/eventing/rabbitmq-install.md
260+
# N.B. this duplicates an "eventing" topic above, cross-referenced here.
261+
- Eventing Channels: eventing/channels/channels-crds.md
262+
- Integrations:
263+
- Install cert-manager: install/installing-cert-manager.md
264+
- Install Knative Backstage plugin: install/installing-backstage-plugins.md
265+
# Vendor list
266+
- Using a Knative-based offering: install/knative-offerings.md
267+
- Configuring Knative:
268+
# TODO: add a doc on editing ConfigMaps
269+
- Configure high-availability components: serving/config-ha.md
270+
- Exclude namespaces from the Knative webhook: serving/webhook-customizations.md
271+
- Networking Options:
272+
- Configure the ingress gateway: serving/setting-up-custom-ingress-gateway.md
273+
- Configure domain names: serving/using-a-custom-domain.md
274+
- Istio Authorization: serving/istio-authorization.md
275+
- Extending Queue Proxy image with QPOptions: serving/queue-extensions.md
276+
- Serving configuration:
277+
- Configure Deployment resources: serving/configuration/deployment.md
278+
- Configure gradual rollout of traffic to Revisions: serving/configuration/rolling-out-latest-revision-configmap.md
279+
- Config Revision Garbage Collection: serving/revisions/revision-admin-config-options.md
280+
- Configure the Defaults ConfigMap: serving/configuration/config-defaults.md
281+
- Serving encryption configuration:
282+
- Overview: serving/encryption/encryption-overview.md
283+
- Configure cert-manager integration: serving/encryption/configure-certmanager-integration.md
284+
- Configure external domain encryption: serving/encryption/external-domain-tls.md
285+
- Configure cluster-local domain encryption: serving/encryption/cluster-local-domain-tls.md
286+
- Configure Knative system-internal encryption: serving/encryption/system-internal-tls.md
287+
- Eventing configuration:
288+
- Configure Broker defaults: eventing/configuration/broker-configuration.md
289+
- Configure Channel defaults: eventing/configuration/channel-configuration.md
290+
- Configure Apache Kafka Channel defaults: eventing/configuration/kafka-channel-configuration.md
291+
- Configure Kafka Broker features: eventing/brokers/broker-types/kafka-broker/configuring-kafka-features.md
292+
- Configure event source defaults: eventing/configuration/sources-configuration.md
293+
- Configure Sugar Controller: eventing/configuration/sugar-configuration.md
294+
- Configure KEDA Autoscaling of Knative Kafka Resources: eventing/configuration/keda-configuration.md
295+
- Flagged features:
296+
- Serving Features: serving/configuration/feature-flags.md
297+
- Eventing Features:
298+
- Configuring Features: eventing/features/README.md
299+
- DeliverySpec.Timeout field: eventing/features/delivery-timeout.md
300+
- DeliverySpec.RetryAfterMax field: eventing/features/delivery-retryafter.md
301+
- New APIServerSource Filters: eventing/features/new-apiserversource-filters.md
302+
- KReference.Group field: eventing/features/kreference-group.md
303+
- Knative reference mapping: eventing/features/kreference-mapping.md
304+
- EventType auto creation: eventing/features/eventtype-auto-creation.md
305+
- Transport Encryption: eventing/features/transport-encryption.md
306+
- Sender Identity: eventing/features/sender-identity.md
307+
- Authorization: eventing/features/authorization.md
308+
- Eventing with Istio: eventing/features/istio-integration.md
309+
- Cross Namespace Event Links: eventing/features/cross-namespace-event-links.md
310+
- Securing Knative:
311+
- Security Disclosure: reference/security/README.md
312+
- Threat Model: reference/security/threat-model.md
313+
- Verifying Knative Images: reference/security/verifying-images.md
314+
- Verifying Knative Binaries: reference/security/verifying-cli.md
315+
# TODO: add some observability documentation
316+
- Observability:
317+
- Serving Request traces: serving/observability/accessing-traces.md
318+
- Collecting Serving logs: serving/observability/logging/collecting-logs.md
319+
- Collecting Eventing logs: eventing/observability/logging/collecting-logs.md
320+
- Configuring Serving logging: serving/observability/logging/config-logging.md
321+
- Configuring Serving Request logging: serving/observability/logging/request-logging.md
322+
- Configuring Eventing logging: eventing/observability/logging/config-logging.md
323+
- Accessing CloudEvent traces: eventing/observability/accessing-traces.md
317324
# Upgrading Knative
318-
- Upgrading your installation:
325+
- Upgrading and removing:
319326
- About upgrading Knative: install/upgrade/README.md
320327
- Checking your Knative version: install/upgrade/check-install-version.md
321328
- Upgrading with kubectl: install/upgrade/upgrade-installation.md
322329
- Upgrading with the Knative Operator: install/upgrade/upgrade-installation-with-operator.md
323-
# Uninstall
324-
- Uninstalling Knative: install/uninstall.md
330+
- Uninstalling Knative: install/uninstall.md
325331
# Troubleshooting
326332
- Troubleshooting Knative: install/troubleshooting.md
327333
###############################################################################
@@ -331,11 +337,4 @@ nav:
331337
- Code sample overview: samples/README.md
332338
- Serving code samples: samples/serving.md
333339
- Eventing code samples: samples/eventing.md
334-
# Reference docs
335-
- Reference:
336-
- Security:
337-
- Security Disclosure: reference/security/README.md
338-
- Threat Model: reference/security/threat-model.md
339-
- Verifying Knative Images: reference/security/verifying-images.md
340-
- Verifying Knative Binaries: reference/security/verifying-cli.md
341-
- Release notes: reference/relnotes/README.md
340+
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
audience: administrator
3+
components:
4+
- eventing
5+
- serving
6+
function: concept
7+
---
8+
9+
# Administration Overview
10+
11+
The Knative [Serving](../serving/) and [Eventing](../ eventing/) components extend Kubernetes clusters to provide consistent serverless compute and event-delivery interfaces for developers. (Knative [Functions](../functions/) provides primarily client-side tools for more easily building containers.) This means that Serving and Eventing need to be installed on a Kubernetes cluster, and they extend the Kubernetes API using [Custom Resources Definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
12+
13+
Knative aims to integrate with Kubernetes, so existing tools for managing Kubernetes such as RBAC, quota, admission control, and monitoring should "just work". By using a plug-in model for underlying HTTP and event routing functionality, Knative aims to integrate with existing battle-tested software you may already have installed on your cluster, such as Istio, Contour, Kafka, NATS or RabbitMQ. Knative also provides lightweight implementations for these functions if you are looking to avoid pulling in large, complex systems.

0 commit comments

Comments
 (0)