Cluster Operator Listing

[Jaime Magiera]

Hi foks,

Here’s the start of the document I described at the last meeting which lists the cluster operators. Each entry will have a description and a link to the operator’s respective git repository. It’s a work in progress. I do think having such a document can help someone understand the components of an OpenShift cluster at a basic level. 

https://github.com/JaimeMagiera/random/blob/main/README.MD

Jaime Magiera
Lead DevOps Engineer
ICPSR

"If you want to build a ship, don't drum up people together to collect wood and don't assign them tasks and work, but rather teach them to long for the endless immensity of the sea." 
-- Antoine de Saint-Exupery

[Michael McCune]

On Sun, Jul 24, 2022 at 3:58 PM Jaime Magiera <jai...@umich.edu> wrote:

Hi foks,

Here’s the start of the document I described at the last meeting which lists the cluster operators. Each entry will have a description and a link to the operator’s respective git repository. It’s a work in progress. I do think having such a document can help someone understand the components of an OpenShift cluster at a basic level. 

https://github.com/JaimeMagiera/random/blob/main/README.MD

nice start, is this something you are looking for contributions from the community on or are you planning to fill it out?

just wondering because i'm happy to fill out the ones i know =)

peace o/

 

Jaime Magiera
Lead DevOps Engineer
ICPSR

"If you want to build a ship, don't drum up people together to collect wood and don't assign them tasks and work, but rather teach them to long for the endless immensity of the sea." 
-- Antoine de Saint-Exupery

--
You received this message because you are subscribed to the Google Groups "okd-wg" group.
To unsubscribe from this group and stop receiving emails from it, send an email to okd-wg+un...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/okd-wg/995A22D3-DE47-4B60-9D54-1D71B145A60B%40umich.edu.

[Jaime Magiera]

I think it would be fantastic if people helped :)

Jaime Magiera
Lead DevOps Engineer
ICPSR

"If you want to build a ship, don't drum up people together to collect wood and don't assign them tasks and work, but rather teach them to long for the endless immensity of the sea." 
-- Antoine de Saint-Exupery

[W. Trevor King]

On Sun, Jul 24, 2022 at 12:58 PM Jaime Magiera wrote:
> Here’s the start of the document I described at the last meeting which lists the cluster operators. Each entry will have a description and a link to the operator’s respective git repository...
>
> https://github.com/JaimeMagiera/random/blob/main/README.MD

Maintaining this sort of parallel, external docs is a lot of work (or
tends to bit-rot). In official docs, there are [1,2]. Those are
still parallel docs that are a lot of work to maintain, but having the
work centralized in openshift-docs [3] at least limits the amount of
bit-rot. And then there's also the from-the-source:

$ oc adm release info --commits
quay.io/openshift-release-dev/ocp-release:4.10.22-x86_64 | grep github
alibaba-cloud-controller-manager
https://github.com/openshift/cloud-provider-alibaba-cloud
db2d118ad70ff62a2111e83a8d14c5b32e176b38
alibaba-cloud-csi-driver
https://github.com/openshift/alibaba-cloud-csi-driver
3ddbb2b9d4994206183b5ffd6a0872ad9a5ce193
alibaba-disk-csi-driver-operator
https://github.com/openshift/alibaba-disk-csi-driver-operator
f0d6966321e3d416efec2ac7405494b057cb35f8
alibaba-machine-controllers
https://github.com/openshift/cluster-api-provider-alibaba
0206121348c9a0d220dd6805cea79d1eae7fd3e0
...

where ideally clicking through to any of the listed GitHub
repositories will land you on a welcoming README with "what this
repository is about" onboarding. In practice, some READMEs are better
at this than others (maintainers are shipping bug fixes and features
more often than they're onboarding new contributors or GitHub-browsing
users). But again, it's all open source, so folks can chip in and
work to make any opaque/missing READMEs more accessible.

Cheers,

[1]: https://docs.openshift.com/container-platform/4.10/operators/operator-reference.html#platform-operators-ref
[2]: https://docs.okd.io/latest/operators/operator-reference.html#platform-operators-ref
[3]: https://github.com/openshift/openshift-docs/blob/main/operators/operator-reference.adoc

[Jaime Magiera]

Ahhh, thank you. I never noticed that page before. 

A question for the Documentation Subgroup would be if this page should be surfaced by referencing it someplace prominent on the website. For example, a blog post that outlines the conceptual framework for OKD/OpenShift which references the Operators page. 

I’ll put it on the agenda for today. 

Jaime Magiera
Lead DevOps Engineer
ICPSR

"If you want to build a ship, don't drum up people together to collect wood and don't assign them tasks and work, but rather teach them to long for the endless immensity of the sea." 
-- Antoine de Saint-Exupery

[W. Trevor King]

On Tue, Jul 26, 2022 at 7:05 AM Jaime Magiera wrote:
> A question for the Documentation Subgroup would be if this page should be surfaced by referencing it someplace prominent on the website.

Within the docs, there's the somewhat higher-profile Architecture ->
Control plane architecture -> Platform Operators path in [1]. But
yeah, no harm in "formal docs can by dry, so here's a splashy tour of
some highlights to give newcomers some landmarks".

Cheers,
Trevor

[1]: https://docs.okd.io/latest/architecture/control-plane.html#platform-operators_control-plane