Admin overview doc #6412
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,130 @@ | ||||||
| --- | ||||||
| audience: administrator | ||||||
| components: | ||||||
| - serving | ||||||
| - eventing | ||||||
| function: reference | ||||||
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| --- | ||||||
| # Overview | ||||||
|
|
||||||
| This page provides guidance for administrators on how to install and manage Knative on an existing Kubernetes cluster, and assumes you have familiarity the following: | ||||||
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| - Kubernetes and Kubernetes administration. | ||||||
| - The `kubectl`CLI tool. You can use existing Kubernetes management tools (policy, quota, etc) to manage Knative workloads. | ||||||
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
| - The Cloud Native Computing Foundation (CNCF) for which Knative is one of its projects, along with Kubernetes, Prometheus, and Istio. | ||||||
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| Additionally, you should have cluster-admin permissions or equivalent to to install software and manage resources in all clusters in the namespace. | ||||||
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| To simplify Knative installation and administration, you can use the Knative operator and the Knative CLI tool, but they are not required. | ||||||
|
|
||||||
| Essentially, Knative aims to extend Kubernetes, and build on existing capabilities where feasible. It has two main underlying components that support plugging in multiple underlying transports within the same cluster: | ||||||
evankanderson marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| - Serving: Pods and pluggable network ingress routes. | ||||||
| - Eventing: Pods and pluggable message transports (e.g. Kafka, RabbitMQ) | ||||||
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| Knative has default lightweight implementations if you don't already have a solution. | ||||||
|
||||||
| Knative has default lightweight implementations if you don't already have a solution. | |
| Knative has a default lightweight messaging implementation if you don't already have a solution. |
Outdated
Member
There was a problem hiding this comment.
I feel like we need a transition sentence that explains something about managing the lifecycle of Knative, or maybe:
As a cluster administrator, you should not need to directly manage applications and their supporting network and messaging resources on a day-to-day basis; Knative enabled application developers to manage their own functions and configure networking and message infrastructure within the bounds of their own namespace. Cluster administrators are needed for the following operations:
- Installing and upgrading the Knative components on the cluster
- Creating Kubernetes namespaces for development teams, and managing controls on these namespaces
- Configuring Knative and supporting infrastructure like message brokers and DNS
- Securing the underlying Kubernetes cluster and Knative installation
The administration documentation is intended to help you accomplish these tasks.
Outdated
There was a problem hiding this comment.
Suggested change
| You install Knative using YAML files and other resources either aided or not by the Knative Operator. The Knative Operator is a custom controller that extends the Kubernetes API to install Knative components. It allows you to automate applying the content, along with patching the contents to customize them. You install the Knative Operator either by using the Knative CLI Operator Plugin or by using KS8 Manifests or by Yelm. | |
| You install Knative using YAML files and other resources either aided or not by the Knative Operator. The Knative Operator is a custom controller that extends the Kubernetes API to install Knative components. It enables you to automate applying the content and patching the contents to customize them. You install the Knative Operator either by using the Knative CLI Operator Plugin, or by using KS8 Manifests or Yelm. |
evankanderson marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
evankanderson marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
Member
There was a problem hiding this comment.
Suggested change
| | YAML-based install | Knative Operator install| | |
| | YAML installation | Knative Operator | |
Outdated
Member
There was a problem hiding this comment.
This last one isn't quite right -- the KnativeServing and KnativeEventing resources could be stored under version control, and a YAML installation doesn't have to be stored in GitHub. (In fact, I'd probably suggest storing things in a git repository either way.) What about the following:
Suggested change
| | Version and audit control as YAML files are stored in a GitHub repository.| No version or audit control. | | |
| | Track and manage changes using existing YAML tooling. | Manage changes using Kubernetes resources. | |
evankanderson marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
evankanderson marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
There was a problem hiding this comment.
Suggested change
| This is the easiest install option and suitable for using if customization is not a concern. | |
| This is the easiest install option, suitable if customization is not a concern. |
evankanderson marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
evankanderson marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
Member
There was a problem hiding this comment.
This table is kind of weird, particularly since the previous table was column-major, but this one is row-major.
Member
There was a problem hiding this comment.
I'd probably drop this table, though the other table seemed informative.
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
Member
There was a problem hiding this comment.
This sentence is weird and not technically correct. Folks should not be modifying the CRDs (which define the shapes of Knative resources), but should instead be editing the ConfigMaps in the controller namespace. ConfigMap is a native Kubernetes type, which is basically a map from string-to-string.
Outdated
There was a problem hiding this comment.
Rewrite this. The construction ("using X using Y using Z") is awkward and confusing.
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
There was a problem hiding this comment.
Suggested change
| The following table lists the names of CRDs (metadata name) for the Serving and Eventing components. They are defined by `eventing-crds.yaml` and `serving-crds.yaml` in the [Knative Eventing installation files](/install/yaml-install/eventing/eventing-installation-files.md) and [Knative Serving installation Files](/install/yaml-install/serving/serving-installation-files.md), respectively. | |
| The following table lists the metadata names of CRDs for the Serving and Eventing components defined by `eventing-crds.yaml` and `serving-crds.yaml` in the [Knative Eventing installation files](/install/yaml-install/eventing/eventing-installation-files.md) and [Knative Serving installation Files](/install/yaml-install/serving/serving-installation-files.md), respectively. |
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
evankanderson marked this conversation as resolved.
Show resolved
Hide resolved
evankanderson marked this conversation as resolved.
Show resolved
Hide resolved
Outdated
There was a problem hiding this comment.
Suggested change
| You can also install these plugins service to extend Knative capabilities for service meshes: | |
| You can install these plugins service to extend Knative capabilities for service meshes: |
Outdated
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
iRaindrop marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.