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

add new command karmadactl explain #5393

Merged
merged 1 commit into from
Aug 26, 2024

Conversation

hulizhe
Copy link
Contributor

@hulizhe hulizhe commented Aug 18, 2024

What type of PR is this?
/kind feature

What this PR does / why we need it:
add new command karmadactl explain

$ karmadactl explain explain pods --operation-scope members --cluster member1
KIND:       Pod
VERSION:    v1

DESCRIPTION:
    Pod is a collection of containers that can run on a host. This resource is
    created by clients and scheduled onto hosts.
    
FIELDS:
  apiVersion    <string>
    APIVersion defines the versioned schema of this representation of an object.
    Servers should convert recognized schemas to the latest internal value, and
    may reject unrecognized values. More info:
    https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

  kind  <string>
    Kind is a string value representing the REST resource this object
    represents. Servers may infer this from the endpoint the client submits
    requests to. Cannot be updated. In CamelCase. More info:
    https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  metadata      <ObjectMeta>
    Standard object's metadata. More info:
    https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
... ...

$ karmadactl explain explain pods                                            
KIND:       Pod
VERSION:    v1

DESCRIPTION:
    Pod is a collection of containers that can run on a host. This resource is
    created by clients and scheduled onto hosts.
    
FIELDS:
  apiVersion    <string>
    APIVersion defines the versioned schema of this representation of an object.
    Servers should convert recognized schemas to the latest internal value, and
    may reject unrecognized values. More info:
    https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

  kind  <string>
    Kind is a string value representing the REST resource this object
    represents. Servers may infer this from the endpoint the client submits
    requests to. Cannot be updated. In CamelCase. More info:
    https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

  metadata      <ObjectMeta>
    Standard object's metadata. More info:
......


$ karmadactl explain pods --operation-scope members                  
error: must specify a member cluster

Which issue(s) this PR fixes:
Parts of #5249

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

`karmadactl`: add a new command `karmadactl explain` to describe fields and structure of various resources in Karmada control plane or a member cluster. 

@karmada-bot karmada-bot added the kind/feature Categorizes issue or PR as related to a new feature. label Aug 18, 2024
@karmada-bot karmada-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Aug 18, 2024
@codecov-commenter
Copy link

codecov-commenter commented Aug 18, 2024

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 0% with 41 lines in your changes missing coverage. Please review.

Project coverage is 30.95%. Comparing base (e13518d) to head (216b465).
Report is 2 commits behind head on master.

Files Patch % Lines
pkg/karmadactl/explain/explain.go 0.00% 40 Missing ⚠️
pkg/karmadactl/karmadactl.go 0.00% 1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5393      +/-   ##
==========================================
- Coverage   30.97%   30.95%   -0.03%     
==========================================
  Files         637      638       +1     
  Lines       44266    44307      +41     
==========================================
+ Hits        13712    13714       +2     
- Misses      29563    29602      +39     
  Partials      991      991              
Flag Coverage Δ
unittests 30.95% <0.00%> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hulizhe hulizhe force-pushed the karmadactlexplain branch 3 times, most recently from c95b990 to d53160d Compare August 19, 2024 07:22
@zhzhuang-zju
Copy link
Contributor

/retest

@zhzhuang-zju
Copy link
Contributor

/lgtm
cc @RainbowMango

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 19, 2024
@hulizhe hulizhe force-pushed the karmadactlexplain branch from d53160d to 54cc6ff Compare August 26, 2024 08:44
@karmada-bot karmada-bot removed the lgtm Indicates that a PR is ready to be merged. label Aug 26, 2024
@hulizhe hulizhe force-pushed the karmadactlexplain branch from 54cc6ff to 56aa114 Compare August 26, 2024 08:47
@hulizhe hulizhe force-pushed the karmadactlexplain branch from 56aa114 to 0a9d6a4 Compare August 26, 2024 09:14
Signed-off-by: hulizhe <pompeii.hu@gmail.com>
@hulizhe hulizhe force-pushed the karmadactlexplain branch from 0a9d6a4 to 216b465 Compare August 26, 2024 09:29
Copy link
Member

@RainbowMango RainbowMango left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 26, 2024
@karmada-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RainbowMango

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 26, 2024
@karmada-bot karmada-bot merged commit 80037ce into karmada-io:master Aug 26, 2024
12 checks passed
@RainbowMango RainbowMango added this to the v1.11 milestone Aug 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants