istio.io
istio.io copied to clipboard
istio
IstioOperator IstioComponentSetSpec needs field description
https://istio.io/latest/docs/reference/config/istio.operator.v1alpha1/#IstioComponentSetSpec
When I read above document, it was hard to think the components of IstioOperator deploys when it's enabled
I want to fill out the descriptions for some fields.
base- "When enabled, it deploys istio CRDs"
pilot- "When enabled, it deploys istiod"
For now, I just want to fill description of base and pilot.
(It would be nice when cni and ztunnel description also filled out!)
I want to contribute the document, but this page is placed on docs/reference/ dir. Is there something that I should know??
Thank you for reading :pray:
For cni, it would be nice to suggest this document: "Install Istio with the Istio CNI plugin", and for ztunnel, it would be nice to reference "ambient mesh".
cni- "Enable this when want to use istio CNI plugin. See "Install Istio with the Istio CNI plugin","
ztunnel- "Enable this when want to deploy ambient mesh. See "[Ambient Mesh]"(https://istio.io/latest/docs/ops/ambient/)""
Note that this page is changed here: https://github.com/istio/api/blob/master/operator/v1alpha1/operator.proto
Thank you, @ericvn! That was precisely the explanation I needed! ❤️
Wishing you a fantastic day! 😄
What you should find is that after updating the .proto file, a make gen should update the associated pb.html file. The automation will copy the pb.html file to istio.io. It should be noted that an istio/api update gets copied to preliminary.istio.io normally on a daily basis (however just before a release, like we are getting ready for 1.21.0, those are instead copied from the upcoming release's branch (currently release-1.21)). A cherry-pick to the current release is needed in istio/api to get the changes updated in istio.io (and we only copy those files at a patch release). That's a lot to understand, but wanted to highlight that a change in istio/api can take a while to show up in the docs.