Create admin guide by abrennan89 · Pull Request #3526 · knative/docs

abrennan89 · 2021-05-03T22:37:28Z

Part of #3525

knative-prow-robot · 2021-05-03T22:37:37Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please ask for approval from abrennan89 after the PR has been reviewed.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

abrennan89 · 2021-05-04T18:18:11Z

/hold

omerbensaadon · 2021-05-04T18:32:02Z

/assign

vaikas

Thanks!! Couple of small things.

vaikas · 2021-05-04T18:49:08Z

+  - /docs/serving/metrics/#admin
+---
+
+Administrators can monitor the Knative Serving control plane by looking at the metrics exposed by each Knative Serving component.


ditto. data plane.

well :) reading through these, maybe both control and dataplane? Which makes me think if they should be grouped then differently? Thinks like Controller / Webhook vs. Activator. I think some of these are more applicable for the Application developer vs. cluster admin, but just jotting it down and get somebody from serving to help :)

Yes, always jot it down, this is all good context 😄

Is there a description of control vs dataplane anywhere that we can reuse, or can we create a blurb about each of those to explain the difference in the metrics topics? @skonto is explaining the difference between these something you could help with?

Updated these to say data plane and control plane, can you open a follow up issue to improve these docs maybe please and loop in SMEs so we're not blocking the PR on this?

omerbensaadon

/lgtm

Peppered in a few references to what things would look like in mkDocs 👍🏼

This is an awesome start to make your Miro 🍝 vision into a reality.

omerbensaadon · 2021-05-05T14:29:35Z

+
+The default configuration will classify logs into:
+
+- Knative apps, or pods with an `app=Knative` label


Should apps be "services" here?

I think it's the same difference but I didn't write this, I'd imagine @skonto did maybe, I just cleaned it up, so let's get his opinion before we change any wording relating to components?

I didnt write this part but I think using services is more precise, although this label is used in different places and seems a bit confusing to me eg. serving controller.

evankanderson

Thanks for doing this!

There are a couple places where our docs weren't in optimal places before (that you couldn't have known about, because the doc didn't say); I've left some suggestions on content reorganization that this PR made clear because of that.

Other than that, this looks great, thank you very much!

evankanderson · 2021-05-05T16:19:30Z

+
+* [Knative Eventing](../eventing/): Easily route events between on-cluster and off-cluster components by exposing event routing as configuration rather than embedded in code.
+
+These components are delivered as Kubernetes custom resource definitions (CRDs), which can be configured by a cluster administrator to provide default settings for developer-created applications and event workflow components.


I think there's also some common configuration options for administrators around telemetry (config-logging, config-observability) that should probably move to the admin guide:

https://knative.dev/docs/install/collecting-metrics/
https://knative.dev/docs/install/collecting-logs/

(I'm not quite sure what to do with the "here's a local-logs-collection solution" at the end of the second; probably turn it into something real or go back and delete it.)

Nevermind, it looks like you did this. Do you want to mention "common configuration options" as another section here, or just rely on the left-hand nav?

I don't want to add a bunch of links to maintain really until things settle down a bit with moving stuff, but for now I've added the contents list back to the page; does that work for you?

evankanderson · 2021-05-05T16:29:32Z

+weight: 50
+type: "docs"
+aliases:
+  - /docs/install/collecting-logs


Do we want to make "logs" a top-level next to "install", add a "configuration" sub-tree to hold all the configuration, or have a "common" sub-tree to hold configuration that's common to Serving and Eventing (off the top of my head, the high-availability configuration, logging, and monitoring)?

(I'm trying to avoid the "too many items at one level in the LHS navigation" problem we have today.)

Can you add this as a suggestion to the Miro doc please so I can see better what you're saying / how this fits in?
We can follow it up in another PR if we want to move this

@evankanderson tracing too?

…ninstall

knative-prow-robot · 2021-05-05T22:46:42Z

New changes are detected. LGTM label has been removed.

omerbensaadon · 2021-05-06T12:19:51Z

/lgtm 👍🏼

RichieEscarez · 2021-05-07T21:29:42Z

FYI: This PR build is failing with:

1:45:27 PM: Error: Error building site: "/opt/build/repo/content/en/community/contributing/elections/2021-TOC/candidate-dprotaso.md:2:1": failed to unmarshal YAML: yaml: line 2: mapping values are not allowed in this context

RichieEscarez · 2021-05-10T21:01:43Z

1:45:27 PM: Error: Error building site: ....2021-TOC/candidate-dprotaso.md

@abrennan89 This should fix the broken builds: knative/website#297

knative-prow-robot · 2021-05-14T21:45:17Z

@abrennan89: PR needs rebase.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

abrennan89 · 2021-05-17T20:17:44Z

A lot of this work will be negated by the new docs structure and things like the getting started, so I'm just going to start working on the mkdocs branch instead and close this PR.

knative-prow-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 3, 2021

google-cla Bot added the cla: yes Indicates the PR's author has signed the CLA. label May 3, 2021

knative-prow-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 3, 2021

matzew reviewed May 4, 2021

View reviewed changes

Comment thread docs/eventing/getting-started.md

matzew reviewed May 4, 2021

View reviewed changes

Comment thread docs/eventing/getting-started.md

knative-prow-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 4, 2021

abrennan89 changed the title ~~[WIP] Create admin guide~~ Create admin guide May 4, 2021

knative-prow-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 4, 2021

knative-prow-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 4, 2021

knative-prow-robot assigned omerbensaadon May 4, 2021

abrennan89 requested review from omerbensaadon, skonto and vaikas May 4, 2021 18:35

vaikas reviewed May 4, 2021

View reviewed changes

omerbensaadon reviewed May 5, 2021

View reviewed changes

knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label May 5, 2021

evankanderson reviewed May 5, 2021

View reviewed changes

abrennan89 added 9 commits May 5, 2021 17:33

create admin guide, move admin metrics

ae3afb0

minor updates

fbf49f0

minor tweaks, moved webhook-cutomizations to admin guide

22868bc

added serving subfolder, moved HA

46c2d14

added eventing tasks

2153507

soem cleanup

0f46f58

cleanup

9d3093f

moved metrics, logging, install to admin guide. Moved upgrading and u…

4af5630

…ninstall

moved HA and webhook docs to top level under admin

cc6153d

abrennan89 force-pushed the 3525 branch from 316d622 to cc6153d Compare May 5, 2021 22:46

knative-prow-robot removed the lgtm Indicates that a PR is ready to be merged. label May 5, 2021

abrennan89 added 4 commits May 5, 2021 17:47

shorten titles

1513812

mention data, control planes

a130553

added todo for istio

a9b89f2

minor tweaks

543e6fa

omerbensaadon mentioned this pull request May 6, 2021

Sanity-check Install-related content #3537

Closed

3 tasks

RichieEscarez mentioned this pull request May 10, 2021

Update the Staging branch knative/website#297

Merged

abrennan89 removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 12, 2021

knative-prow-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label May 14, 2021

abrennan89 closed this May 17, 2021

abrennan89 deleted the 3525 branch August 26, 2022 17:54


		The default configuration will classify logs into:

		- Knative apps, or pods with an `app=Knative` label


		* [Knative Eventing](../eventing/): Easily route events between on-cluster and off-cluster components by exposing event routing as configuration rather than embedded in code.

		These components are delivered as Kubernetes custom resource definitions (CRDs), which can be configured by a cluster administrator to provide default settings for developer-created applications and event workflow components.

Conversation

abrennan89 commented May 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

knative-prow-robot commented May 3, 2021

Uh oh!

Uh oh!

Uh oh!

abrennan89 commented May 4, 2021

Uh oh!

omerbensaadon commented May 4, 2021

Uh oh!

vaikas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

omerbensaadon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

skonto May 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

evankanderson left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

knative-prow-robot commented May 5, 2021

Uh oh!

omerbensaadon commented May 6, 2021

Uh oh!

RichieEscarez commented May 7, 2021

Uh oh!

RichieEscarez commented May 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

knative-prow-robot commented May 14, 2021

Uh oh!

abrennan89 commented May 17, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

abrennan89 commented May 3, 2021 •

edited

Loading

skonto May 10, 2021 •

edited

Loading

RichieEscarez commented May 10, 2021 •

edited

Loading