-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Update the process to build api-docs, generate CRD manifests and code #2046
Conversation
64869af
to
31e5487
Compare
4bf3d84
to
5a2821e
Compare
/assign @yuchaoran2011 @vara-bonthu |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ChenYi015 Great work on updating the process for building API documentation and generating CRD manifests.
This will streamline the workflow and improve maintainability.
PR looks good to me.
5e2964f
to
4470b41
Compare
PTAL @yuchaoran2011, thanks. |
b4b27bd
to
f1506f1
Compare
@yuchaoran2011 Could you merge this PR first? This will make the development process much more easier. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Neat improvements! Common tasks will be much more convenient to perform. Need a chart version bump and then should be good to merge
Signed-off-by: Yi Chen <github@chenyicn.net>
Signed-off-by: Yi Chen <github@chenyicn.net>
Signed-off-by: Yi Chen <github@chenyicn.net>
Signed-off-by: Yi Chen <github@chenyicn.net>
Signed-off-by: Yi Chen <github@chenyicn.net>
Signed-off-by: Yi Chen <github@chenyicn.net>
Signed-off-by: Yi Chen <github@chenyicn.net>
Signed-off-by: Yi Chen <github@chenyicn.net>
Signed-off-by: Yi Chen <github@chenyicn.net>
@yuchaoran2011 Rebased and bumped the chart version. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vara-bonthu, yuchaoran2011 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 |
…kubeflow#2046) * Update .gitignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update .dockerignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update Makefile Signed-off-by: Yi Chen <github@chenyicn.net> * Update the process to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Update the workflow to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Use controller-gen to generate CRD and deep copy related methods Signed-off-by: Yi Chen <github@chenyicn.net> * Update helm chart CRDs Signed-off-by: Yi Chen <github@chenyicn.net> * Update workflow for building spark operator Signed-off-by: Yi Chen <github@chenyicn.net> * Update README.md Signed-off-by: Yi Chen <github@chenyicn.net> --------- Signed-off-by: Yi Chen <github@chenyicn.net>
…kubeflow#2046) * Update .gitignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update .dockerignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update Makefile Signed-off-by: Yi Chen <github@chenyicn.net> * Update the process to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Update the workflow to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Use controller-gen to generate CRD and deep copy related methods Signed-off-by: Yi Chen <github@chenyicn.net> * Update helm chart CRDs Signed-off-by: Yi Chen <github@chenyicn.net> * Update workflow for building spark operator Signed-off-by: Yi Chen <github@chenyicn.net> * Update README.md Signed-off-by: Yi Chen <github@chenyicn.net> --------- Signed-off-by: Yi Chen <github@chenyicn.net> (cherry picked from commit 779ea3d)
* Update helm docs (#2081) Signed-off-by: Carlos Sánchez Páez <karlossanpa@gmail.com> (cherry picked from commit eca3fc8) * Update the process to build api-docs, generate CRD manifests and code (#2046) * Update .gitignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update .dockerignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update Makefile Signed-off-by: Yi Chen <github@chenyicn.net> * Update the process to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Update the workflow to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Use controller-gen to generate CRD and deep copy related methods Signed-off-by: Yi Chen <github@chenyicn.net> * Update helm chart CRDs Signed-off-by: Yi Chen <github@chenyicn.net> * Update workflow for building spark operator Signed-off-by: Yi Chen <github@chenyicn.net> * Update README.md Signed-off-by: Yi Chen <github@chenyicn.net> --------- Signed-off-by: Yi Chen <github@chenyicn.net> (cherry picked from commit 779ea3d) * Add topologySpreadConstraints (#2091) * Update README and documentation (#2047) * Update docs Signed-off-by: Yi Chen <github@chenyicn.net> * Remove docs and update README Signed-off-by: Yi Chen <github@chenyicn.net> * Add link to monthly community meeting Signed-off-by: Yi Chen <github@chenyicn.net> --------- Signed-off-by: Yi Chen <github@chenyicn.net> Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> * Add PodDisruptionBudget to chart (#2078) * Add PodDisruptionBudget to chart Signed-off-by: Carlos Sánchez Páez <karlossanpa@gmail.com> Signed-off-by: Carlos Sánchez Páez <sanchezpaezcarlos33@gmail.com> Signed-off-by: Carlos Sánchez Páez <karlossanpa@gmail.com> * PR comments Signed-off-by: Carlos Sánchez Páez <karlossanpa@gmail.com> --------- Signed-off-by: Carlos Sánchez Páez <karlossanpa@gmail.com> Signed-off-by: Carlos Sánchez Páez <sanchezpaezcarlos33@gmail.com> Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> * Set topologySpreadConstraints Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> * Update README and increase patch version Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> * Revert replicaCount change Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> * Update README after master merger Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> * Update README Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> --------- Signed-off-by: Yi Chen <github@chenyicn.net> Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> Signed-off-by: Carlos Sánchez Páez <karlossanpa@gmail.com> Signed-off-by: Carlos Sánchez Páez <sanchezpaezcarlos33@gmail.com> Co-authored-by: Yi Chen <github@chenyicn.net> Co-authored-by: Carlos Sánchez Páez <karlossanpa@gmail.com> (cherry picked from commit 4108f54) * Use controller-runtime to reconsturct spark operator (#2072) * Use controller-runtime to reconstruct spark operator Signed-off-by: Yi Chen <github@chenyicn.net> * Update helm charts Signed-off-by: Yi Chen <github@chenyicn.net> * Update examples Signed-off-by: Yi Chen <github@chenyicn.net> --------- Signed-off-by: Yi Chen <github@chenyicn.net> (cherry picked from commit 0dc641b) --------- Co-authored-by: Carlos Sánchez Páez <karlossanpa@gmail.com> Co-authored-by: jbhalodia-slack <jbhalodia@salesforce.com>
…kubeflow#2046) * Update .gitignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update .dockerignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update Makefile Signed-off-by: Yi Chen <github@chenyicn.net> * Update the process to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Update the workflow to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Use controller-gen to generate CRD and deep copy related methods Signed-off-by: Yi Chen <github@chenyicn.net> * Update helm chart CRDs Signed-off-by: Yi Chen <github@chenyicn.net> * Update workflow for building spark operator Signed-off-by: Yi Chen <github@chenyicn.net> * Update README.md Signed-off-by: Yi Chen <github@chenyicn.net> --------- Signed-off-by: Yi Chen <github@chenyicn.net>
…kubeflow#2046) * Update .gitignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update .dockerignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update Makefile Signed-off-by: Yi Chen <github@chenyicn.net> * Update the process to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Update the workflow to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Use controller-gen to generate CRD and deep copy related methods Signed-off-by: Yi Chen <github@chenyicn.net> * Update helm chart CRDs Signed-off-by: Yi Chen <github@chenyicn.net> * Update workflow for building spark operator Signed-off-by: Yi Chen <github@chenyicn.net> * Update README.md Signed-off-by: Yi Chen <github@chenyicn.net> --------- Signed-off-by: Yi Chen <github@chenyicn.net>
…kubeflow#2046) * Update .gitignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update .dockerignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update Makefile Signed-off-by: Yi Chen <github@chenyicn.net> * Update the process to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Update the workflow to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Use controller-gen to generate CRD and deep copy related methods Signed-off-by: Yi Chen <github@chenyicn.net> * Update helm chart CRDs Signed-off-by: Yi Chen <github@chenyicn.net> * Update workflow for building spark operator Signed-off-by: Yi Chen <github@chenyicn.net> * Update README.md Signed-off-by: Yi Chen <github@chenyicn.net> --------- Signed-off-by: Yi Chen <github@chenyicn.net> Signed-off-by: Kevin Wu <kevin.wu@momenta.ai>
…ubeflow#2108) * Update helm docs (kubeflow#2081) Signed-off-by: Carlos Sánchez Páez <karlossanpa@gmail.com> (cherry picked from commit eca3fc8) * Update the process to build api-docs, generate CRD manifests and code (kubeflow#2046) * Update .gitignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update .dockerignore Signed-off-by: Yi Chen <github@chenyicn.net> * Update Makefile Signed-off-by: Yi Chen <github@chenyicn.net> * Update the process to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Update the workflow to generate api docs Signed-off-by: Yi Chen <github@chenyicn.net> * Use controller-gen to generate CRD and deep copy related methods Signed-off-by: Yi Chen <github@chenyicn.net> * Update helm chart CRDs Signed-off-by: Yi Chen <github@chenyicn.net> * Update workflow for building spark operator Signed-off-by: Yi Chen <github@chenyicn.net> * Update README.md Signed-off-by: Yi Chen <github@chenyicn.net> --------- Signed-off-by: Yi Chen <github@chenyicn.net> (cherry picked from commit 779ea3d) * Add topologySpreadConstraints (kubeflow#2091) * Update README and documentation (kubeflow#2047) * Update docs Signed-off-by: Yi Chen <github@chenyicn.net> * Remove docs and update README Signed-off-by: Yi Chen <github@chenyicn.net> * Add link to monthly community meeting Signed-off-by: Yi Chen <github@chenyicn.net> --------- Signed-off-by: Yi Chen <github@chenyicn.net> Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> * Add PodDisruptionBudget to chart (kubeflow#2078) * Add PodDisruptionBudget to chart Signed-off-by: Carlos Sánchez Páez <karlossanpa@gmail.com> Signed-off-by: Carlos Sánchez Páez <sanchezpaezcarlos33@gmail.com> Signed-off-by: Carlos Sánchez Páez <karlossanpa@gmail.com> * PR comments Signed-off-by: Carlos Sánchez Páez <karlossanpa@gmail.com> --------- Signed-off-by: Carlos Sánchez Páez <karlossanpa@gmail.com> Signed-off-by: Carlos Sánchez Páez <sanchezpaezcarlos33@gmail.com> Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> * Set topologySpreadConstraints Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> * Update README and increase patch version Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> * Revert replicaCount change Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> * Update README after master merger Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> * Update README Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> --------- Signed-off-by: Yi Chen <github@chenyicn.net> Signed-off-by: jbhalodia-slack <jbhalodia@salesforce.com> Signed-off-by: Carlos Sánchez Páez <karlossanpa@gmail.com> Signed-off-by: Carlos Sánchez Páez <sanchezpaezcarlos33@gmail.com> Co-authored-by: Yi Chen <github@chenyicn.net> Co-authored-by: Carlos Sánchez Páez <karlossanpa@gmail.com> (cherry picked from commit 4108f54) * Use controller-runtime to reconsturct spark operator (kubeflow#2072) * Use controller-runtime to reconstruct spark operator Signed-off-by: Yi Chen <github@chenyicn.net> * Update helm charts Signed-off-by: Yi Chen <github@chenyicn.net> * Update examples Signed-off-by: Yi Chen <github@chenyicn.net> --------- Signed-off-by: Yi Chen <github@chenyicn.net> (cherry picked from commit 0dc641b) --------- Co-authored-by: Carlos Sánchez Páez <karlossanpa@gmail.com> Co-authored-by: jbhalodia-slack <jbhalodia@salesforce.com>
Purpose of this PR
Proposed changes:
make manifests
,controller-gen
will be automatically installed intobin
directory if neededmake generate
,controller-gen
will be automatically installed intobin
directory if neededmake build-api-docs
will automatically installgen-crd-api-reference-docs
underbin
directory and then used it to generate docs, no need to build docker image locally anymore.bin/
to.gitignore
Change Category
Indicate the type of change by marking the applicable boxes:
Rationale
Add some usefule targets to Makefile, the availabe targets are as follows:
Checklist
Before submitting your PR, please review the following:
Additional Notes