hazelcast / hazelcast-platform-operator-docs

Source content for the Kubernetes Operator of Hazelcast Platform (Enterprise)
3 stars 13 forks source link

Fixed examples in scheduling-configuration page #41

Closed chobostar closed 2 years ago

chobostar commented 2 years ago
$ k explain hazelcast.spec.scheduling.topologySpreadConstraints.labelSelector
KIND:     Hazelcast
VERSION:  hazelcast.com/v1alpha1

RESOURCE: labelSelector <Object>

DESCRIPTION:
     LabelSelector is used to find matching pods. Pods that match this label
     selector are counted to determine the number of pods in their corresponding
     topology domain.

FIELDS:
   matchExpressions <[]Object>
     matchExpressions is a list of label selector requirements. The requirements
     are ANDed.

   matchLabels  <map[string]string>
     matchLabels is a map of {key,value} pairs. A single {key,value} in the
     matchLabels map is equivalent to an element of matchExpressions, whose key
     field is "key", the operator is "In", and the values array contains only
     "value". The requirements are ANDed.
devOpsHazelcast commented 2 years ago

CLA assistant check
All committers have signed the CLA.

netlify[bot] commented 2 years ago

Deploy Preview for pedantic-goldberg-f76ec1 ready!

Name Link
Latest commit 794c35dbc0df342d94c06c4fe09788c2975ea5a0
Latest deploy log https://app.netlify.com/sites/pedantic-goldberg-f76ec1/deploys/62f3b71f21bd8f00084ca5df
Deploy Preview https://deploy-preview-41--pedantic-goldberg-f76ec1.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

JakeSCahill commented 2 years ago

Looks good. For the API reference changes, I believe the content is autogenerated. So we need to update the source as well.

hasancelik commented 2 years ago

@chobostar Could you check @JakeSCahill's comment and resolve conflicts?

chobostar commented 2 years ago

@hasancelik yes, I have just checked again

Yaml files are included into adoc as is: https://github.com/hazelcast/hazelcast-platform-operator-docs/pull/7/files#diff-76bc1e26c86f00d6cc19714cd56c2364d216a8c049aee1a6380bcb52dde1f7c7R43

Files were added manually by hand. I don't see any automation there. Thus fix the yaml file means fix the rendered doc.

chobostar commented 2 years ago

Here are fixed examples: https://deploy-preview-41--pedantic-goldberg-f76ec1.netlify.app/operator/latest-snapshot/scheduling-configuration.html#pod-affinity-and-pod-anti-affinity

https://deploy-preview-41--pedantic-goldberg-f76ec1.netlify.app/operator/latest-snapshot/scheduling-configuration.html#topology-spread-constraints

As far as I see everything as expected.

JakeSCahill commented 2 years ago

corev1.DoNotSchedule became DoNotSchedule. Does this affect the API reference here? https://deploy-preview-41--pedantic-goldberg-f76ec1.netlify.app/operator/latest-snapshot/api-ref.html#schedulingconfiguration

chobostar commented 2 years ago

corev1.DoNotSchedule became DoNotSchedule. Does this affect the API reference here? https://deploy-preview-41--pedantic-goldberg-f76ec1.netlify.app/operator/latest-snapshot/api-ref.html#schedulingconfiguration

Thanks for clarifying!

That was just typo in example yaml.

Nothing changed in API, so we don't need to change API ref.


Here is CRD part connected with the PR: https://github.com/hazelcast/hazelcast-platform-operator/blob/main/bundle.yaml#L937-L1033 as I see the schema exactly the same as fixed version of our example yaml.

And here https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#topologyspreadconstraint-v1-core

WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) 

also everything is consistent

JakeSCahill commented 2 years ago

Looks good šŸ‘Œ

chobostar commented 2 years ago

@chobostar Could you check @JakeSCahill's comment and resolve conflicts?

@hasancelik we are done here and ready to be merged.

hasancelik commented 2 years ago

@chobostar Thanks a lot šŸ‘