Skip to content
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
71 commits
Select commit Hold shift + click to select a range
616d748
Admin and Install docs
iRaindrop Sep 26, 2025
0dd8ca6
Update admin-overview.md
iRaindrop Sep 26, 2025
07f0603
Update admin-overview.md
iRaindrop Sep 29, 2025
d4520ee
Update admin-overview.md
iRaindrop Sep 29, 2025
7a6e659
Update admin-overview.md
iRaindrop Sep 30, 2025
9ae7119
Update admin-overview.md
iRaindrop Sep 30, 2025
98305ae
Update admin-overview.md
iRaindrop Sep 30, 2025
27f6603
Update admin-overview.md
iRaindrop Sep 30, 2025
7ea43dd
Rebuild attempt
iRaindrop Sep 30, 2025
e5f2397
Update admin-overview.md
iRaindrop Oct 1, 2025
24a8160
Update admin-overview.md
iRaindrop Oct 1, 2025
ff0aee6
Update admin-overview.md
iRaindrop Oct 1, 2025
f10feed
Update admin-overview.md
iRaindrop Oct 2, 2025
4eb34b8
Update admin-overview.md
iRaindrop Oct 3, 2025
bd968dd
Update admin-overview.md
iRaindrop Oct 3, 2025
718c280
Update admin-overview.md
iRaindrop Oct 4, 2025
94ca152
Update admin-overview.md
iRaindrop Oct 5, 2025
36d81c2
Update admin-overview.md
iRaindrop Oct 6, 2025
01bcffb
Update admin-overview.md
iRaindrop Oct 6, 2025
d925a17
Update admin-overview.md
iRaindrop Oct 6, 2025
b8a76ea
Update admin-overview.md
iRaindrop Oct 6, 2025
8dc7ca6
Update admin-overview.md
iRaindrop Oct 6, 2025
cbce6fb
Update admin-overview.md
iRaindrop Oct 6, 2025
6fea983
Update admin-overview.md
iRaindrop Oct 6, 2025
6ce725f
Update admin-overview.md
iRaindrop Oct 7, 2025
221b573
Update admin-overview.md
iRaindrop Oct 9, 2025
0f4d62f
Merge branch 'main' into bh_admin-install-docs
iRaindrop Oct 9, 2025
31d22c4
Update .nav.yml
iRaindrop Oct 9, 2025
82445f0
Update admin-overview.md
iRaindrop Oct 9, 2025
0683ac0
Update admin-overview.md
iRaindrop Oct 9, 2025
5abf3b5
Moved install content from overview to install readme
iRaindrop Oct 9, 2025
f5471d8
Reviewer edits and misc
iRaindrop Oct 10, 2025
7bf0355
Wrapping up installation content
iRaindrop Oct 10, 2025
58c26ea
Update .nav.yml
iRaindrop Oct 10, 2025
9c622bb
Update .nav.yml
iRaindrop Oct 10, 2025
6034fe6
Update README.md
iRaindrop Oct 10, 2025
0051916
Update README.md
iRaindrop Oct 10, 2025
2d969a0
Update README.md
iRaindrop Oct 10, 2025
01dcd5e
Put admin install info back in overview
iRaindrop Oct 13, 2025
794f8fa
Update .nav.yml
iRaindrop Oct 13, 2025
b28fa41
Update admin-overview.md
iRaindrop Oct 13, 2025
ec47c75
Link fixes
iRaindrop Oct 13, 2025
ebda591
Update admin-overview.md
iRaindrop Oct 13, 2025
1d9250d
Update admin-overview.md
iRaindrop Oct 13, 2025
322c66d
Update admin-overview.md
iRaindrop Oct 13, 2025
eea866f
Processed reviewer edits
iRaindrop Oct 13, 2025
e3ef406
Formatting fixes
iRaindrop Oct 13, 2025
cbfcce6
Update admin-overview.md
iRaindrop Oct 13, 2025
af71cd0
Update admin-overview.md
iRaindrop Oct 14, 2025
596bab7
minor edit to rebuild
iRaindrop Oct 14, 2025
aa154d0
Update README.md
iRaindrop Oct 14, 2025
c608e5a
Update README.md
iRaindrop Oct 14, 2025
bbb6829
Merge branch 'main' into bh_admin-install-docs
iRaindrop Oct 14, 2025
1e41e00
Update docs/versioned/admin/admin-overview.md
iRaindrop Oct 14, 2025
e129a69
Update docs/versioned/admin/admin-overview.md
iRaindrop Oct 14, 2025
a39a442
Update docs/versioned/admin/admin-overview.md
iRaindrop Oct 14, 2025
d0c2a87
Update docs/versioned/admin/admin-overview.md
iRaindrop Oct 14, 2025
431fcf8
Update docs/versioned/admin/admin-overview.md
iRaindrop Oct 14, 2025
9f251eb
Update docs/versioned/install/README.md
iRaindrop Oct 14, 2025
d266c9f
Processed reviewer edits
iRaindrop Oct 14, 2025
58deddc
Update README.md
iRaindrop Oct 14, 2025
3d2afae
Copy edits and helpful links
iRaindrop Oct 15, 2025
0cf79c7
Delete README.md
iRaindrop Oct 15, 2025
7fce951
Update docs/versioned/install/README.md
iRaindrop Oct 16, 2025
52921ba
Update docs/versioned/admin/admin-overview.md
iRaindrop Oct 16, 2025
41227bb
Update docs/versioned/admin/admin-overview.md
iRaindrop Oct 16, 2025
5511678
Update docs/versioned/admin/admin-overview.md
iRaindrop Oct 16, 2025
63dd0ee
Update docs/versioned/admin/admin-overview.md
iRaindrop Oct 16, 2025
20b6e2c
Update docs/versioned/install/README.md
iRaindrop Oct 16, 2025
266a627
Update docs/versioned/install/README.md
iRaindrop Oct 16, 2025
42c61a7
Update admin-overview.md
iRaindrop Oct 16, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/versioned/.nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ nav:
# Administration
###############################################################################
- Administration:
# TODO: add a general overview of Knative for administrators
- Administration overview: admin/admin-overview.md
- Installing Knative: install/README.md
# YAML Installation
- Install Knative with YAML:
Expand Down
125 changes: 125 additions & 0 deletions docs/versioned/admin/admin-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
---
audience: administrator
components:
- serving
- eventing
function: reference
---
# Overview

Knative has a set of tools and capabilities to administer your Kubernetes clusters. This article provides a overview of Knative features, capabilities, and resources of interest to Kubernetes Administrators, and is organized by the following areas:

- Installation
- Configuration
- Monitoring and Observability
- Security and Access Control
- Updates and Maintenance

## Installation

Use the Installation Roadmap for guidance on installing Knative using the resources and tool choices that best fit your needs. You can install using YAML resources, manifests, or CLI tools that include the Knative Operator.

The Knative Operator is a custom controller that extends the Kubernetes API to install Knative components.

You can install Knative components in three ways:

- Use a [YAML-based installation](/install/yaml-install/README.md)
- Use the [Knative Operator CLI plugin](/install/operator/knative-with-operator-cli.md)
- Use the [Knative Operator](/install/operator/knative-with-operators.md) with YAML resource files and the `kubectl` CLI.

- [Knative Serving installation files](/install/yaml-install/serving/serving-installation-files.md)
- [Knative Eventing installation files](/install/yaml-install/eventing/eventing-installation-files.md)

### Recommended plugins

You can also install these plugins service to extend Knative capabilities for service meshes and application security:

- [Istio for Knative](/install/installing-istio.md)
- [Knative Backstage plugin](/install/installing-backstage-plugins.md)
- [Installing Security-Guard](/serving/app-security/security-guard-install.md)

For un-installations, see [Uninstalling Knative](/install/uninstall.md).

## Configurations

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Configurations
## Configuring


Knative provides optimization capabilities for the Serving and Eventing components and settings for administering your clusters.

### ConfigMaps

The Knative Operator propagates values from custom resources to the ConfigMaps object, a storage object of non-confidential values in key-value pairs. You can [Configuring Knative using the Operator](/install/operator/configuring-with-operator.md) and define custom resource definitions:

- [Knative Serving CRDs](/install/operator/configuring-serving-cr.md)
- [Knative Eventing CRDs](/install/operator/configuring-eventing-cr.md)

See [Configure the Defaults ConfigMap](/serving/configuration/config-defaults.md).

TODO: Editing ConfigMaps guidance

### Autoscaling, high-availability and load balancing

For the Serving component, you can set global or per-revision configurations for [Supported autoscaler types](/serving/autoscaling/autoscaler-types.md). You can [Configure metrics](/serving/autoscaling/autoscaling-metrics.md) for a per revision configuration, constantly monitored by the Autoscaler. The Autoscaler maintains targeted values according to the configured metrics. See [Configuring targets](/serving/autoscaling/autoscaling-targets.md).

Autoscaling includes [Configuring scale to zero](/serving/autoscaling/scale-to-zero.md), concurrency, [Configuring concurrency](/serving/autoscaling/concurrency.md), [Configuring the requests per second (RPS) target](/serving/autoscaling/rps-target.md), [Configuring scale bounds](/serving/autoscaling/scale-bounds.md), and [Additional autoscaling configuration for Knative Pod Autoscaler](/serving/autoscaling/kpa-specific.md)

See [Configuring high-availability components](/serving/config-ha.md).

For load balancing, you can [Configure Activator capacity](/serving/load-balancing/activator-capacity.md) and [Target-Burst capacity](/serving/load-balancing/target-burst-capacity.md).

### Networking

Networking administrative tasks include [Exclude namespaces from the Knative webhook](/serving/webhook-customizations.md), [Configuring the ingress gateway](/serving/setting-up-custom-ingress-gateway.md), [Configuring domain names](/serving/using-a-custom-domain.md), and [Feature and extension flags](/serving/configuration/feature-flags.md).

### Encryption

You can have apply encryption as needed to your domain and clusters:

- [Configure external domain encryption](/serving/encryption/external-domain-tls.md)
- [Configure cluster-local domain encryption](/serving/encryption/cluster-local-domain-tls.md)
- [Configure Knative system-internal encryption](/serving/encryption/system-internal-tls.md)

### Eventing

The configuration options for eventing comprise the following areas:

- Event sources, see [Configure event source defaults](/eventing/configuration/sources-configuration.md) and also refer to [Knative reference mapping](/eventing/features/kreference-mapping.md).
- Brokers. See [Developer configuration options](/eventing/brokers/broker-developer-config-options.md) and [Configure Broker defaults](/eventing/configuration/broker-configuration.md) for an overview of broker configurations and an example.
- Kafka, a distributed event store and stream-processing platform. See [Configure Kafka features](/eventing/brokers/broker-types/kafka-broker/configuring-kafka-features.md) and [Configure Apache Kafka Channel defaults](/eventing/configuration/kafka-channel-configuration.md). See also [Configure KEDA Autoscaling of Knative Kafka Resources](/eventing/configuration/keda-configuration.md)
- Istio, a programmable, application-aware network. See [Eventing with Istio](/eventing/features/istio-integration.md).
- Channels. See [Configure Channel defaults](/eventing/configuration/channel-configuration.md).

### Blog articles

| Article | Description |
| --- | --- |
| [Configurable RuntimeClassNames](../../blog/articles/kubevirt_meets_eventing.md) | Configure the default the RuntimeClassName field for deployments as selected from the Knative Service label selector. |

## Monitoring and Observability

Knative is instrumented with OpenTelemetry. For metrics, see the [Metrics Reference](/serving/observability/metrics/serving-metrics.md) and [Collecting metrics](/serving/observability/metrics/collecting-metrics.md). You can access [CloudEvents traces](/serving/observability/accessing-traces.md).

For logging Serving activity, see [Collecting logs](/serving/observability/logging/collecting-logs.md), [Configuring logging](/serving/observability/logging/config-logging.md), and [Configuring Request logging](/serving/observability/logging/request-logging.md).

For logging Eventing activity, see [Collecting logs](/eventing/observability/logging/collecting-logs.md) and [Configuring logging](/eventing/observability/logging/config-logging.md).

### Blog articles

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Include procedures, reference information, and coneptual content in the documentation proper. Blogs are not documentation.


| Article | Description |
| --- | --- |
| [Monitoring Virtual Machines with Knative Eventing](../../blog/articles/kubevirt_meets_eventing.md) | Monitor KubeVirt VMs with Knative Eventing building blocks. |
| [Distributed tracing with Knative, OpenTelemetry and Jaeger](../../blog/articles/distributed-tracing.md) | Describes using Jaeger through a mix of OpenCensus and OpenTelemetry. |

## Security and Access Control

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Security and Access Control
Enforcing security


[Security-Guard](/serving/app-security/security-guard-about.md) provides visibility into the security status of applications deployed by Knative Services. See [Verifying Knative Images](/reference/security/verifying-images.md) for verifying binaries for authenticity before deploying.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Security-Guard](/serving/app-security/security-guard-about.md) provides visibility into the security status of applications deployed by Knative Services. See [Verifying Knative Images](/reference/security/verifying-images.md) for verifying binaries for authenticity before deploying.
[Security-Guard](/serving/app-security/security-guard-about.md) provides visibility into the security status of applications deployed by Knative Services. See [Verifying Knative Images](/reference/security/verifying-images.md) for verifying authenticity of binaries.

For access control, see [Transport Encryption](/eventing/features/transport-encryption.md), [Sender Identity](/eventing/features/sender-identity.md), and [cert-manager](/install/installing-cert-manager.md).

### Blog articles

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above re blogs.


| Article | Description |
| --- | --- |
| [Knative and Backstage](../../blog/articles/knative-backstage-plugins.md) | A platform for building developer portals.|
| [Knative Backstage Security](../../blog/articles/knative-backstage-security.md) | How to secure the communication between the Knative Event Mesh plugin and the backend. |

## Updates and Maintenance

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Updates and Maintenance
Updating and maintaining


For Knative updates, see [About upgrading Knative](/install/upgrade/README.md) and [Checking your Knative version](/install/upgrade/check-install-version.md). The current Knative version is the shown in the version drop-down in the upper-left corner of this page. Refer to [Upgrading with the Knative Operator](/install/upgrade/upgrade-installation-with-operator.md) or [Upgrading with kubectl](/install/upgrade/upgrade-installation.md).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change
"About upgrading Knative"
to
"Upgrading Knative"
(here and the actual linked heading).

Loading