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

Separate all the comments in respective buckets for better readability #575

Merged
merged 1 commit into from
Feb 12, 2025

Conversation

vishnoianil
Copy link
Member

No description provided.

@vishnoianil
Copy link
Member Author

Currently make help shows the commands as follows

Usage:
  make <target>
  ui-image            Build container image for the InstructLab UI
  ps-image            Build container image for the InstructLab PathService
  healthcheck-sidecar-image  Build container image for the InstructLab Healthcheck-Sidecar
  validate-podman-container-engine  Validate the podman container engine in PATH
  stop-dev-native-podman  Stop UI Native mode development stack running in podman
  start-dev-native-podman  Start UI Native mode development stack in podman
  stop-dev-github-podman  Stop UI Github mode development stack running in podman
  start-dev-github-podman  Start UI Github mode development stack in podman
  load-images         Load images onto Kind cluster
  setup-kind          Create a Kind cluster with ingress enabled
  start-dev-kind      Setup a Kind cluster and deploy InstructLab UI on it
  stop-dev-kind       Stop the Kind cluster to destroy the development environment
  deploy              Deploy a InstructLab UI development stack onto a kubernetes cluster
  redeploy            Redeploy the InstructLab UI stack onto a kubernetes cluster
  undeploy            Undeploy the InstructLab UI stack from a kubernetes cluster
  check-kubeseal      Check kubeseal binary is properly installed
  check-sealed-secrets-controller  Check sealed-secrets-operater installed in current cluster
  deploy-prod-openshift  Deploy production stack of the InstructLab UI on OpenShift
  redeploy-prod-openshift  Redeploy production stack of the InstructLab UI on OpenShift
  undeploy-prod-openshift  Undeploy production stack of the InstructLab UI on OpenShift
  deploy-umami-prod-openshift  Deploy Umami stack onto an OpenShift production cluster
  undeploy-umami-prod-openshift  Undeploy Umami stack from an OpenShift production cluster
  deploy-qa-openshift  Deploy QA stack of the InstructLab UI on OpenShift
  redeploy-qa-openshift  Redeploy QA stack of the InstructLab UI on OpenShift
  undeploy-qa-openshift  Undeploy QA stack of the InstructLab UI on OpenShift
  deploy-umami-qa-openshift  Deploy Umami stack onto an OpenShift QA cluster
  undeploy-umami-qa-openshift  Undeploy Umami stack from an OpenShift QA cluster
  check-dev-container-installed  Check the devcontainer binary is in $PATH
  build-dev-build-dev-container  Build the dev container:
  start-dev-container  Start the dev container
  enter-dev-container  Enter the dev container
  cycle-dev-container  Recyle (Stop, remove, build and start) the dev container
  md-lint             Lint markdown files
  action-lint         Lint GitHub Action workflows
  yaml-lint           Lint yaml files
  start-dev-local     Start the npm and pathservice local instances
  stop-dev-local      Stop the npm and pathservice local instances
  start-healthcheck-sidecar-local  Start the healthcheck-sidecar local instance
  stop-healthcheck-sidecar-local  Stop the healtcheck-sidecar local instance
  start-healthcheck-sidecar-model-server-local  Start the healthcheck-sidecar model server instance
  stop-healthcheck-sidecar-model-server-local  Stop the healtcheck-sidecar model server local instance

This patch adds help command on each Makefile to display commands categorized as per their function

Usage:
  make <target>

Build Images - Helper commands for building relevant container images
  ui-image            Build container image for the InstructLab UI
  ps-image            Build container image for the InstructLab PathService
  healthcheck-sidecar-image  Build container image for the InstructLab Healthcheck-Sidecar

Podman Deployment - Helper commands for deploying UI stack in Podman
  validate-podman-container-engine  Validate the podman container engine in PATH
  stop-dev-native-podman  Stop UI Native mode development stack running in podman
  start-dev-native-podman  Start UI Native mode development stack in podman
  stop-dev-github-podman  Stop UI Github mode development stack running in podman
  start-dev-github-podman  Start UI Github mode development stack in podman

Kind Deployment - Helper commands for deploying UI stack in Kind cluster
  load-images         Load images onto Kind cluster
  setup-kind          Create a Kind cluster with ingress enabled
  start-dev-kind      Setup a Kind cluster and deploy InstructLab UI on it
  stop-dev-kind       Stop the Kind cluster to destroy the development environment
  deploy              Deploy a InstructLab UI development stack onto a kubernetes cluster
  redeploy            Redeploy the InstructLab UI stack onto a kubernetes cluster
  undeploy            Undeploy the InstructLab UI stack from a kubernetes cluster

Openshift Production Deployment - Helper commands for deploying UI stack in Openshift production cluster
  check-kubeseal      Check kubeseal binary is properly installed
  check-sealed-secrets-controller  Check sealed-secrets-operater installed in current cluster
  deploy-prod-openshift  Deploy production stack of the InstructLab UI on OpenShift
  redeploy-prod-openshift  Redeploy production stack of the InstructLab UI on OpenShift
  undeploy-prod-openshift  Undeploy production stack of the InstructLab UI on OpenShift
  deploy-umami-prod-openshift  Deploy Umami stack onto an OpenShift production cluster
  undeploy-umami-prod-openshift  Undeploy Umami stack from an OpenShift production cluster

Openshift Production Deployment - Helper commands for deploying UI stack in Openshift production cluster
  deploy-qa-openshift  Deploy QA stack of the InstructLab UI on OpenShift
  redeploy-qa-openshift  Redeploy QA stack of the InstructLab UI on OpenShift
  undeploy-qa-openshift  Undeploy QA stack of the InstructLab UI on OpenShift
  deploy-umami-qa-openshift  Deploy Umami stack onto an OpenShift QA cluster
  undeploy-umami-qa-openshift  Undeploy Umami stack from an OpenShift QA cluster

Devcontainer Deployment - Helper commands for deploying UI stack in dev container
  check-dev-container-installed  Check the devcontainer binary is in $PATH
  build-dev-build-dev-container  Build the dev container:
  start-dev-container  Start the dev container
  enter-dev-container  Enter the dev container
  cycle-dev-container  Recyle (Stop, remove, build and start) the dev container

Lint commands - Commands for linting various file formats
  md-lint             Lint markdown files
  action-lint         Lint GitHub Action workflows
  yaml-lint           Lint yaml files

Local Deployment - Helper commands for deploying UI stack locally on your machine
  start-dev-local     Start the npm and pathservice local instances
  stop-dev-local      Stop the npm and pathservice local instances
  start-healthcheck-sidecar-local  Start the healthcheck-sidecar local instance
  stop-healthcheck-sidecar-local  Stop the healtcheck-sidecar local instance
  start-healthcheck-sidecar-model-server-local  Start the healthcheck-sidecar model server instance
  stop-healthcheck-sidecar-model-server-local  Stop the healtcheck-sidecar model server local instance

Signed-off-by: Anil Vishnoi <vishnoianil@gmail.com>
Copy link
Collaborator

@Gregory-Pereira Gregory-Pereira left a comment

Choose a reason for hiding this comment

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

/lgtm

@Gregory-Pereira Gregory-Pereira merged commit 5f3670c into instructlab:main Feb 12, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants