Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Update comments for CRP #265

Merged
merged 4 commits into from
Sep 7, 2022
Merged

feat: Update comments for CRP #265

merged 4 commits into from
Sep 7, 2022

Conversation

circy9
Copy link
Contributor

@circy9 circy9 commented Sep 7, 2022

Description of your changes

  • Update comments of CRP
  • Use the same kubebuilder annotations for all the conditions
  • Add the missing "+" for some kubebuilder annotations
  • Disclose the list of reserved namespaces and resource types that are not placed
  • Update comments for conditions of MC to make comments consistent
  • Update the list view of CRP
    Example:
    ❯ k get crp -o=custom-columns='NAME:.metadata.name,GEN:.metadata.generation,Scheduled:.status.conditions[?(@.type=="Scheduled")].status,ScheduledGEN:.status.conditions[?(@.type=="Scheduled")].observedGeneration,Applied:.status.conditions[?(@.type=="Applied")].status,AppliedGEN:.status.conditions[?(@.type=="Applied")].observedGeneration'
    NAME GEN Scheduled ScheduledGEN Applied AppliedGEN
    hello-world 3 False 3 True 2

// - reserved namespaces including: default, kube-* (reserved for Kubernetes system namespaces), fleet-* (reserved for fleet system namespaces).
// - reserved fleet resource types including: MemberCluster, InternalMemberCluster, ClusterResourcePlacement, MultiClusterService, ServiceImport, etc.

Fixes #264

I have:

  • Run make reviewable to ensure this PR is ready for review.

How has this code been tested

None as this only changes comments.

@circy9 circy9 changed the title [feat] Update comments for CRP feat: Update comments for CRP Sep 7, 2022
apis/v1alpha1/clusterresourceplacement_types.go Outdated Show resolved Hide resolved
apis/v1alpha1/clusterresourceplacement_types.go Outdated Show resolved Hide resolved
apis/v1alpha1/clusterresourceplacement_types.go Outdated Show resolved Hide resolved
apis/v1alpha1/clusterresourceplacement_types.go Outdated Show resolved Hide resolved
apis/v1alpha1/clusterresourceplacement_types.go Outdated Show resolved Hide resolved
apis/v1alpha1/clusterresourceplacement_types.go Outdated Show resolved Hide resolved
@circy9 circy9 merged commit a392579 into main Sep 7, 2022
@zhiying-lin zhiying-lin deleted the liqian/crpcomments branch August 16, 2023 08:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[feature] Improve comments on CRP
3 participants