-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Admin overview config overviews #6482
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
86844ee
ee353b9
39f98bd
a975f5c
4d519f9
5b77048
d09b0f3
500ac2f
4464b7a
3654642
2631259
bc3125a
bc743bf
efa3f03
d6e0422
7404d61
727fffe
b8a0223
27b23a5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,38 +9,60 @@ function: explanation | |
|
|
||
| This page provides guidance for administrators on how to manage Knative on an existing Kubernetes cluster. | ||
|
|
||
| ```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 | ||
| ``` | ||
|
|
||
| As a cluster administrator, your responsibilities include managing the Kubernetes environment, installing cluster-wide components, and enabling developers to deploy applications on the cluster. Knative aims to simplify developer tasks, while aligning with existing management tools and processes. | ||
|
|
||
| Knative includes a plugin system to integrate with existing infrastructure in the cluster, enabling Knative resources such as Routes and Brokers to be implemented using one of multiple underlying suppliers. For example, a Knative Eventing app can deliver events to a Broker that triggers a function based on the received event. In a testing cluster, the delivery might use an in-memory option, while a staging or production environment might use a cloud-provided Kafka service. | ||
|
|
||
| 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 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why are these titles plural? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For a more generic sense, but its a short paragraph and I've picked "Installation decisions" |
||
|
|
||
| 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). | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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.) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added this: Knative installations are not permanent and you can install clusters differently depending on the situation. Although switching services and applications in real time may be possible, a best practice is to start with a new cluster. |
||
|
|
||
| ## Configuring Knative | ||
|
|
||
| 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 | ||
|
|
||
| Knative resources are namespaced. Knative adheres to the Kubernetes model of namespace-based isolation that lets you manage development teams and resources by assigning them to namespaces. | ||
|
|
||
| Namespaces can also isolate boundaries for tooling such as logs, metrics, tracing, CI/CD integrations, and dashboards. The extent of this isolation depends on both the enforcement strategy and how consistently teams adhere to namespace boundaries. | ||
|
|
||
| You can optimize and enforce isolation involving namespaces using standard Kubernetes mechanisms, including: | ||
|
|
||
| - [Role-Based Access Control (RBAC)](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) | ||
| - [Resource Quotas](https://kubernetes.io/docs/concepts/policy/resource-quotas/) | ||
| - [Network Policies](https://kubernetes.io/docs/concepts/services-networking/network-policies/) | ||
| - [Pod Security Standards](https://kubernetes.io/docs/concepts/security/pod-security-standards/) | ||
|
|
||
| ### Configuring Knative components | ||
| ## Configurations | ||
|
|
||
| Knative configurations are performed by the following methods: | ||
|
|
||
| - Editing YAML manifests | ||
| - Editing YAML manifests and applying with the `kubectl` tool | ||
|
|
||
| Modify resource definitions directly, including labels, annotations, and field values. You can use Kubernetes features such as [OPA](https://kubernetes.io/blog/2019/08/06/opa-gatekeeper-policy-and-governance-for-kubernetes/) and [Kyverno](https://kyverno.io) to enforce specific values on a resource type, or use ConfigMaps in plugin installations to set values at the cluster level. | ||
|
|
||
|
|
@@ -50,51 +72,59 @@ Knative configurations are performed by the following methods: | |
|
|
||
| - 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) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The operator can be managed with our without the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks - great clarification - added: You can manage the operator without using the |
||
|
|
||
| ### Configuration tasks | ||
| 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. | ||
|
|
||
| Knative documentation provides the following configuration procedures. This list is subject subject to change. | ||
| ## Configuration summaries | ||
|
|
||
| Configurations for default settings: | ||
| The following sections provide an overview of the current configurations procedures of interest to Administrators. You make these configurations using `kubectl`, with some procedures applying YAML files. | ||
|
|
||
| - [Broker defaults](../eventing/configuration/broker-configuration.md) | ||
| - [ConfigMap defaults](../serving/configuration/config-defaults.md) | ||
| - [Event source defaults](../eventing/configuration/sources-configuration.md) | ||
| - [Channel defaults](../eventing/configuration/channel-configuration.md) | ||
| - [Kafka channel defaults](../eventing/configuration/kafka-channel-configuration.md) | ||
| - [Domain names](../serving/using-a-custom-domain.md) | ||
| - [Ingress gateway replacement](../serving/setting-up-custom-ingress-gateway.md) | ||
| ### Networking | ||
|
|
||
| Configurations for new development: | ||
| | Configuration | ConfigMap | Description | | ||
| | -- | --- | --- | | ||
| | [Domain names](../serving/using-a-custom-domain.md) | `config-domain` | Configure and publish domains. | | ||
| | [Ingress gateway](../serving/setting-up-custom-ingress-gateway.md)| `config-istio` | For new clusters, you can configure your own gateway and underlying service. | | ||
| | [Istio authorization](../serving/istio-authorization.md) | NA | Grant authorization to your deployed Knative services. | | ||
|
|
||
| - [Deployment resources](../serving/configuration/deployment.md) | ||
| - [Istio access to deployed services](../serving/istio-authorization.md) | ||
| - [Namespace exclusion from webhooks](../serving/istio-authorization.md) | ||
| ### Serving | ||
|
|
||
| Configurations for maintenance: | ||
| | Configuration | ConfigMap | Description | | ||
| | -- | --- | --- | | ||
| | [Default configurations](../serving/configuration/config-defaults.md) | `config-defaults` | Default resource values such as performance, hardware, and storage settings. | | ||
| | [Deployment resources](../serving/configuration/deployment.md) | `config-deployment` | Kubernetes deployment resources that back Knative services. | | ||
| | [High-availability](../serving/config-ha.md) | NA | Configure ensure that APIs stay operational if a disruption occurs. | | ||
| | [Garbage collection](../serving/revisions/revision-admin-config-options.md) | `config-gc` | Disable and enable collection and set retention time values. | | ||
| | [Namespace exclusion from webhook](../serving/webhook-customizations.md) | NA | For performance concerns during an upgrade. | | ||
| | [Rollout duration for revisions](../serving/configuration/rolling-out-latest-revision-configmap.md) | `config-network` | Adjust rollout durations to accommodate longer request queues. | | ||
| | [Security - Certificates](../serving/encryption/configure-certmanager-integration.md) | NA | Describes how to manage automatic certificate provisioning. | | ||
| | [Security - Encryptions](../serving/encryption/encryption-overview.md) | `config-network` | Provides links to procedures for encrypting external domains, the local cluster, and system internal. | | ||
|
|
||
| - [Garbage collection](../serving/revisions/revision-admin-config-options.md) | ||
| - [High availability](../serving/config-ha.md) | ||
| - [Rollout duration for revisions](../serving/configuration/rolling-out-latest-revision-configmap.md) | ||
| - [Autoscaling of Kafka features](../eventing/configuration/keda-configuration.md) | ||
| ### Eventing | ||
|
|
||
| Configurations for security encryptions: | ||
| | Configuration | ConfigMap | Description | | ||
| | -- | --- | --- | | ||
| | [Broker defaults](../eventing/configuration/broker-configuration.md) | `config-br-defaults` | Specify your own broker class and channel, or use the default `MTChannelBasedBroker` Broker class and the ConfigMap of channel defaults. | | ||
| | [Broker features (Kafka)](../eventing/brokers/broker-types/kafka-broker/configuring-kafka-features.md) | `config-kafka-features` | Configure options for Broker interactions with Apache Kafka clusters. | | ||
| | [Channel defaults](../eventing/configuration/channel-configuration.md) | `default-ch-webhook` | Default configurations and labels to use for the channel. | | ||
| | [Channel defaults (Kafka)](../eventing/configuration/kafka-channel-configuration.md) | `kafka-channel` | Defines how KafkaChannel instances are created. Requires that KafkaChannel custom resource definitions (CRD) are installed.| | ||
| | [Event source defaults](../eventing/configuration/sources-configuration.md) |`config-ping-defaults` | Configure the PingSource default resources and the maximum data size for CloudEvents it produces. | | ||
| | [KEDA Autoscaling of Kafka Resources](../eventing/configuration/keda-configuration.md) |`config-kafka-features` | Configure how KEDA scales a KafkaSource, trigger, or subscription. Note: This feature is is Alpha pre-release. | | ||
| | [Sugar Controller](../eventing/sugar/README.md) |`config-sugar` | Configure the Sugar controller, which reacts to label configurations to produce or control eventing resources. See also [Knative Eventing Sugar Controller](../eventing/sugar/README.md). | | ||
|
|
||
| - [cert-manager](../serving/encryption/configure-certmanager-integration.md) | ||
| - [External domains](../serving/encryption/external-domain-tls.md) | ||
| - [Local domains](../serving/encryption/cluster-local-domain-tls.md) | ||
| - [system-internal](../serving/encryption/system-internal-tls.md) | ||
| ## Resource scoping and namespaces | ||
|
|
||
| Configurations for extensions: | ||
| Knative resources are namespaced. Knative adheres to the Kubernetes model of namespace-based isolation that lets you manage development teams and resources by assigning them to namespaces. | ||
|
|
||
| - [Kafka Broker features](../serving/encryption/system-internal-tls.md) | ||
| - [Sugar Controller](../eventing/configuration/sugar-configuration.md) | ||
| Namespaces can also isolate boundaries for tooling such as logs, metrics, tracing, CI/CD integrations, and dashboards. The extent of this isolation depends on both the enforcement strategy and how consistently teams adhere to namespace boundaries. | ||
|
|
||
| Configurations for flagging features: | ||
| You can optimize and enforce isolation involving namespaces using standard Kubernetes mechanisms, including: | ||
|
|
||
| - [Serving features](../serving/configuration/feature-flags.md) | ||
| - [Eventing features](../eventing/features/README.md) | ||
| - [Role-Based Access Control (RBAC)](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) | ||
| - [Resource Quotas](https://kubernetes.io/docs/concepts/policy/resource-quotas/) | ||
| - [Network Policies](https://kubernetes.io/docs/concepts/services-networking/network-policies/) | ||
| - [Pod Security Standards](https://kubernetes.io/docs/concepts/security/pod-security-standards/) | ||
|
|
||
| ## Authorizations | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed - will add a graceful lead in