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 Makefile documentation #373

Merged
merged 5 commits into from
Aug 15, 2023
Merged

Add Makefile documentation #373

merged 5 commits into from
Aug 15, 2023

Conversation

ddelange
Copy link
Contributor

Motivation

kserve/modelmesh-runtime-adapter#38 (comment)

Modifications

Double hashtag just above the target

Result

all                       - Alias for `manager`
build                     - Build runtime docker image
check-doc-links           - Check markdown files for invalid links
controller-gen            - Find or download controller-gen
deploy                    - Deploy controller in a k8s cluster
deploy-release            - Deploy release (artifactory creds set via env var)
deploy-release-dev-mode   - Deploy release in dev mode (artifactory creds set via env var)
develop                   - Build develop docker image and run an interactive shell in the develop envionment
docker-build              - Build the docker image
docker-push               - Push the docker image
fmt                       - Run go fmt against code
fvt                       - Run fvt tests. This requires an etcd, kubernetes connection, and model serving installation. Ginkgo CLI is used to run them in parallel
fvt-protoc                - Regenerate the grpc go files from the proto files
fvt-with-deploy           - Alias for `oc-login, deploy-release-dev-mode, fvt`
generate                  - Generate code
help                      - Print Makefile documentation
install                   - Install CRDs into a k8s cluster
manager                   - Build manager binary
manifests                 - Generate manifests e.g. CRD, RBAC etc.
mmesh-codegen             - Model Mesh gRPC codegen
oc-login                  - Login
run                       - Build develop docker image and run a make command in the develop envionment (e.g. `make run fmt` will execute `make fmt` within the docker container)
start                     - Run against a k8s cluster
test                      - Run unit tests
uninstall                 - Uninstall CRDs from a k8s cluster

Signed-off-by: ddelange <14880945+ddelange@users.noreply.github.com>
@ddelange
Copy link
Contributor Author

cc @ckadner

@ckadner ckadner self-requested a review May 19, 2023 17:26
@ckadner ckadner self-assigned this May 19, 2023
@ckadner
Copy link
Member

ckadner commented May 19, 2023

cc @ckadner

Thanks @ddelange this is great. I will add a more detailed review soon.

@ckadner
Copy link
Member

ckadner commented Aug 2, 2023

Hi @ddelange apologies for the long wait. I added a quick review to the sister PR here kserve/modelmesh-runtime-adapter#50

ddelange and others added 3 commits August 3, 2023 09:52
kserve/modelmesh-runtime-adapter#50

Signed-off-by: ddelange <14880945+ddelange@users.noreply.github.com>
Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
- install opposite of uninstall
- deploy opposite of undeploy

Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
@ckadner
Copy link
Member

ckadner commented Aug 15, 2023

@ddelange -- while syncing with the main branch I noticed a few missing help texts and took the opportunity to "harmonize" some of the Make target's names. Could you take another looks to make sure I did not break anything? :-)

@ddelange
Copy link
Contributor Author

awesome!

https://http.cat/202

Copy link
Member

@ckadner ckadner left a comment

Choose a reason for hiding this comment

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

/lgtm

Thank you @ddelange

@ckadner ckadner added the lgtm label Aug 15, 2023
@ckadner ckadner merged commit 27ac6c9 into kserve:main Aug 15, 2023
3 of 4 checks passed
@kserve-oss-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

Approval requirements bypassed by manually added approval.

This pull-request has been approved by: ckadner, ddelange

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

@kserve-oss-bot
Copy link
Collaborator

New changes are detected. LGTM label has been removed.

@ckadner ckadner added this to the v0.11.1 milestone Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants