Cilium installation guide

[vrutkovs]

Cilium (eBPF-based CNI) documentation is about to add OKD instructions. It would be nice to have a similar guide how to install it on OKD side, focusing on baremetal / vSphere / AWS.

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[vrutkovs]

/remove-lifecycle stale

[mburke5678]

@vrutkovs Where would this be documented? okd.io?

[vrutkovs]

It would be best to start with https://github.com/openshift/okd/tree/master/Guides and then port it to docs.okd.io

[mburke5678]

I'm not familiar with the 4.x install process, having never done an install. After reviewing the Cilium install linked above, it seems the major additions would be:

Before OKD install:

specify `networkType: Cilium` in install config
create `cilium` namespace
render Cilium manifest
Copy Cilium manifest to `${CLUSTER_NAME}/manifests`

After OKD install:

enable Cilium ports AWS vs GCP (problematic as it requires jq, which we are not supposed to document)
test Cilium connectivity

I'm concerned that it appears that the Cilium install has not been tested well. We would need to test any changes to the end-user docs.

@vikram-redhat Any thoughts on how/if we should proceed with this request?

[LorbusChris]

@mburke5678 the Cilium network type isn't actually supported in OpenShift.

One probably has to scale down the networking operator for it to work at all. Since this isn't really an official option, I wonder whether a small comment/link to the Cilium docs might suffice here.

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[mburke5678]

@LorbusChris We are not allowed to document unsupported and untested features in the end-user docs. Perhaps we could add something to https://github.com/openshift/okd/tree/master/Guides?

[LorbusChris]

According to https://access.redhat.com/articles/5436171 Cilium is now a supported option. If it still not fits the reqs for the official docs, the Guides folder is certainly a good alternative :)

[vrutkovs]

/lifecycle frozen

iiuc Cilium is supported by Isovalent. Same as Calico, which is supported by the authors, but tested in Openshift's CI since 4.5(?) and not mentioned in the docs.

Guides is probably a good place for this, even as a link to https://docs.cilium.io/en/v1.9/gettingstarted/k8s-install-openshift-okd/