-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Admin overview doc #6412
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?
Admin overview doc #6412
Conversation
Craft an Amin Overview and finish up high-level remaining tasks for install docs.
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: iRaindrop The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
✅ Deploy Preview for knative ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Spelling fix!
Wrote up admin tasks and interests by categories
Changed H1 to include "Knative"
Link testing and de-emphasizing tables
Link fixes
indented bullets test
Settling on combo or paras with lins and minimal bulleted lists
Worked on Configurations section
Worked on the Monitoring and Observability section
Finished initial write-up for each section
Added blog links (as a test)
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.
This reads more like a table of contents than an overview, at the moment.
Looking at I'm noticing that right now it's largely an exposition of the left-hand nav (or desired left-hand nav), which doesn't feel like the best use of reading time.
If you look at https://knative.dev/docs/, it starts out with "what this document is about".
In this case, I think the document is about something like:
Knative consists of several on-cluster components alongside client tools like
kn
andfunc
. This page explains how to install and manage Knative on an existing Kubernetes cluster. It assumes that you are generally familiar with Kubernetes, Kubernetes administration, thekubectl
command, and have at least some familiarity with the larger CNCF ecosystem. Additionally, it assumes that you have the ability to install software and manage resources in all clusters in the namespace (cluster-admin
permissions, or equivalent). When you've finished, you will understand the different Knative components, their roles, the Knative philosophy, and how to enable your cluster's users to develop using Knative.
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.
Comments and suggestions added. Happy to answer questions or explain my reasoning if you have questions. Please respond in the PR.
If I contradict the style guide, go with the style guide.
Processed most reviewer edits
Added "YAML and CLI installations compared" section
Installation, CRD, and ConfigMap guidance
Updates and restructuring sections into Administrative tasks table.
link fixes
Table fix
Table tweaks
Minor edits to rebuild
Minor edit
Misc edits
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.
Admin table is a good organizational aid.
Page headings don't match the left-sidebar TOC entries:
Administration -> Installing Knative
Administration overview -> Overview
Install Knative with YAML -> About YAML-based installation
etc.
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.
Thanks, this is starting to look better, sorry about the big pile of comments, but it seemed useful at this point to get closer to the details.
Processed reviwer edits
With the other PR merged are any changes in this PR still necessary? |
Edits per repurposing
Set admin-overview.md as the top topic
Removed section that will be doc'd elsewhere
Single edit "messaging implementation"
- In-memory (internal no-dependency option) | ||
- Kafka (in-order, high-thoughput but moderate complexity) | ||
- RabbitMQ (configurable order, moderate throughput and complexity) | ||
- NATS (low complexity) |
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.
Below this, I think there's at least one section on the Knative model for a cluster, which generally matches the Kubernetes model:
- Each application or developer team is assigned a namespace. Developers generally have the ability to create / edit resources within that namespace.
- Namespaces should generally act as independent units. This can be enforced with tools like RBAC, quota, and policy.
- Without substantial Kubernetes planning, namespaces are a soft isolation boundary between teams. See the threat model for more details about security between users on the same cluster.
- Developers often need access to additional resources related to their namespace in other services, such as observability (logs, metrics, tracing) and dashboards (e.g. Grafana / Backstage). It's expected that the administrator will provision this access alongside creating the namespace and assigning permissions.
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'm not sure if there's another section or not. I tend to like threes, but I'm not sure I have a third important part at the moment.
Moved install content from administer/admin-overiview.md into the install/README.md
Write an Aministration Overview and finish up high-level remaining tasks for install docs.
Proposed Changes