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 documentation for KubeOps operation "delete" #1371

Merged
merged 4 commits into from
May 3, 2022

Conversation

muffl0n
Copy link
Contributor

@muffl0n muffl0n commented Apr 7, 2022

Change Overview

KubeOps was introduced in #1102 but documentation for operation "delete" is missing from "Kanister Functions".

Pull request type

Please check the type of change your PR introduces:

  • 🚧 Work in Progress
  • 🌈 Refactoring (no functional changes, no api changes)
  • 🐹 Trivial/Minor
  • 🐛 Bugfix
  • 🌻 Feature
  • 🗺️ Documentation
  • 🤖 Test

Issues

Test Plan

  • 💪 Manual
  • ⚡ Unit test
  • 💚 E2E

@muffl0n
Copy link
Contributor Author

muffl0n commented Apr 7, 2022

Resulting docs: Bildschirmfoto 2022-04-07 um 16 40 31

@ihcsim
Copy link
Contributor

ihcsim commented Apr 11, 2022

This LGTM 👍. While you are here 😉, can you also help us to add the Outputs subsection to describe the function outputs? Looking at the code, these should be the relevant fields 👉

// ObjectReference refers to a kubernetes object.
type ObjectReference struct {
// API version of the referent.
APIVersion string `json:"apiVersion"`
// API Group of the referent.
Group string `json:"group"`
// Resource name of the referent.
Resource string `json:"resource"`
// Kind of the referent.
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
Kind string `json:"kind"`
// Name of the referent.
// More info: http://kubernetes.io/docs/user-guide/identifiers#names
Name string `json:"name"`
// Namespace of the referent.
// More info: http://kubernetes.io/docs/user-guide/namespaces
Namespace string `json:"namespace,omitempty"`
}
. Thanks!

@muffl0n
Copy link
Contributor Author

muffl0n commented Apr 14, 2022

As I'm on maternity leave at the moment, I don't have the time. But this PR can surely be merged without the outputs. Documentation for this function might not be perfect, but a step in the right direction.

Co-authored-by: Pavan Navarathna <pavan@kasten.io>
@shuguet shuguet added this to In Progress in Kanister via automation Apr 21, 2022
Kanister automation moved this from In Progress to Reviewer approved Apr 29, 2022
@ihcsim ihcsim added the kueue label Apr 29, 2022
@mergify mergify bot merged commit a838c42 into kanisterio:master May 3, 2022
Kanister automation moved this from Reviewer approved to Done May 3, 2022
akankshakumari393 pushed a commit that referenced this pull request May 9, 2022
* Add documentation for KubeOps operation "delete"

* Add newline

Co-authored-by: Pavan Navarathna <pavan@kasten.io>

Co-authored-by: Pavan Navarathna <pavan@kasten.io>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
@muffl0n muffl0n deleted the add-documentation-kubeops-delete branch May 12, 2022 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants