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

chore: add kubectl equivalent examples #1254

Merged
merged 2 commits into from
Sep 13, 2023
Merged

chore: add kubectl equivalent examples #1254

merged 2 commits into from
Sep 13, 2023

Conversation

Ananya2001-an
Copy link
Member

Related to #1253
Created a kubectl/equivalents folder inside examples. Each file corresponds to the relevant kubectl command making it easier for users to understand the usage of the client. Makes it more readable and maintainable.

Current files added:

  • Create namespace
  • Create Namespace from yaml
  • Create Namespaced pod
  • List namespaces
  • List Pods
  • Create Resource quotas
  • List all Resource quotas

... more to be added

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 8, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

Welcome @Ananya2001-an!

It looks like this is your first PR to kubernetes-client/javascript 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-client/javascript has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Sep 8, 2023
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Sep 8, 2023
@brendandburns
Copy link
Contributor

Thanks for this PR! I think it would be even better to introduce a kubectl.js as part of this library, so that people can simply call the kubectl equivalents.

It would be similar to https://github.com/kubernetes-client/java/tree/master/extended/src/main/java/io/kubernetes/client/extended/kubectl

@Ananya2001-an
Copy link
Member Author

Thanks for this PR! I think it would be even better to introduce a kubectl.js as part of this library, so that people can simply call the kubectl equivalents.

Yeah that sounds good! I will work on it. I think we can even add some tests for the same with jest, wdyt? But I would work on it in a separate PR to keep things simple for now :)

@Ananya2001-an
Copy link
Member Author

Hey @brendandburns I created a Kubectl.ts file taking reference from the java client. Though, I am not very sure about how to create the generic execution calls for each function. Would like some help with that :) I have pushed the changes for your convenience.

@brendandburns
Copy link
Contributor

Yes, you're right, there's no good equivalent of the generic client in Java. We should add that :)

If that's too much work, feel free to revert this PR just to the examples and we can merge those and work on the generic kubectl implementation some other time.

@Ananya2001-an
Copy link
Member Author

Ananya2001-an commented Sep 11, 2023

I have reverted the changes, @brendandburns you can review now :)

@brendandburns
Copy link
Contributor

/lgtm
/approve

Thanks!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 13, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Ananya2001-an, brendandburns

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 13, 2023
@k8s-ci-robot k8s-ci-robot merged commit ba985e5 into kubernetes-client:master Sep 13, 2023
@Ananya2001-an Ananya2001-an deleted the refactor-examples branch September 13, 2023 15:56
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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants