search

vmware-tanzu-labs / educates-training-platform

A platform for hosting interactive workshop environments in Kubernetes, or on top of a local container runtime.
https://docs.educates.dev
Apache License 2.0
63 stars 15 forks source link

Update local build instructions in developer-docs. #408

Closed GrahamDumpleton closed 3 weeks ago

GrahamDumpleton commented 3 weeks ago

Is your feature request related to a problem? Please describe.

Docs in:

use educates CLI to create a local Kind cluster for doing development. The arguments in the example:

educates create-cluster --with-services=false --with-platform=false

These options are only valid for Educates 2.7.x and earlier. In 3.0.x how to create a an empty cluster is different.

Describe the solution you'd like

Update instructions on how to use 3.0.x version of CLI to create local Kind cluster for development, including local image registry etc.

If possible, document how one might bootstrap local development environment without having an existing educates CLI. This may be problematic since creation of a new build of educates CLI likely relies on what the educates CLI creates.

Describe alternatives you've considered

No response

Additional information

No response

GrahamDumpleton commented 3 weeks ago

Command to create empty local cluster using 3.0.x CLI is:

educates create-cluster --cluster-only
GrahamDumpleton commented 3 weeks ago

In:

should mention the:

educates admin registry prune

command as option instead of deleting and recreating the local registry when it's size grows.

GrahamDumpleton commented 3 weeks ago

Sections:

Need to be redone due to single command now to install into existing cluster.

Command is:

educates admin cluster install ...

There is currently no top level command like there is for create-cluster and delete-cluster. A top level command would be nice (install-packages???).

GrahamDumpleton commented 3 weeks ago

The --cluster-only option results in --with-local-secrets being ignored, so will need a note saying to use educates admin secrets sync after creating cluster, if want local secrets cache copied to the cluster.