docs: Added documentation for creating a local developer environment. #225
Conversation
Pull Request Test Coverage Report for Build 8924016783Details
💛 - Coveralls |
…ll commands have been added.
|
Willing to approve this, we have a policy to get two approvers if its a new contributor (someone without approval rights in the codebase) cc: @charliedmcb , @rakechill , @tallaxes if you are interested in reviewing |
|
@jacobbaek would you be interested in contributing some code or are you at the playing with the framework stage? |
|
@Bryce-Soghigian I am interested in contributing code. :) |
* Add installing extension * Add comparing if condition about golang version * Remove installing the make command
lgtmwe have a policy to get two approvers if its a new contributor (someone without approval rights in the codebase), let me post internally to see if we can get another review |
* Change incorrect comparison statement * Add installing curl command
| @@ -22,6 +23,23 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope | |||
| kubectl scale deployments/inflate --replicas=3 | |||
| ``` | |||
|
|
|||
| ### Use local environment instead of GitHub Codespaces. | |||
| > Tested environment : WSL2 | |||
There was a problem hiding this comment.
Should specify distribution, especially since package management is distribution-specific
Makefile-az.mk
Outdated
| if test -z "$(shell which docker)"; then \ | ||
| curl -fsSL https://get.docker.com | bash -; \ | ||
| fi |
There was a problem hiding this comment.
This should not be needed in WSL2, Docker Desktop for Windows with WSL2 integration would be strongly preferred. (Plus docker client need here is extremely niche - only used for alternative Go helper build ...)
Makefile-az.mk
Outdated
| sudo apt update && sudo apt install curl jq -y | ||
| curl -Lo yq https://github.com/mikefarah/yq/releases/download/v4.43.1/yq_linux_amd64 && chmod +x yq && sudo mv yq /usr/local/bin | ||
| if test -z "$(shell which helm)"; then \ | ||
| curl -sL https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash - |
There was a problem hiding this comment.
For any of the tools that provide an alternative to piping into bash - please use the alternative.
Makefile-az.mk
Outdated
| @@ -25,6 +25,32 @@ az-all-custom-vnet: az-login az-create-workload-msi az-mkaks-custom-vnet az-crea | |||
|
|
|||
| az-all-savm: az-login az-mkaks-savm az-perm-savm az-patch-skaffold-azure az-build az-run az-run-sample ## Provision the infra (ACR,AKS); build and deploy Karpenter; deploy sample Provisioner and workload - StandaloneVirtualMachines | |||
|
|
|||
| install-tools: az-tool ## install tools to create a local developer environment | |||
| sudo apt update && sudo apt install curl jq -y | |||
| curl -Lo yq https://github.com/mikefarah/yq/releases/download/v4.43.1/yq_linux_amd64 && chmod +x yq && sudo mv yq /usr/local/bin | |||
There was a problem hiding this comment.
yq is installed by make toolchain
| @@ -25,6 +25,32 @@ az-all-custom-vnet: az-login az-create-workload-msi az-mkaks-custom-vnet az-crea | |||
|
|
|||
| az-all-savm: az-login az-mkaks-savm az-perm-savm az-patch-skaffold-azure az-build az-run az-run-sample ## Provision the infra (ACR,AKS); build and deploy Karpenter; deploy sample Provisioner and workload - StandaloneVirtualMachines | |||
|
|
|||
| install-tools: az-tool ## install tools to create a local developer environment | |||
There was a problem hiding this comment.
Maybe consider a separate script (under hack) to be called from makefile?
Consider adding shellcheck and pre-commit (and maybe pprof & graphviz - though these may be a little niche ...)
There was a problem hiding this comment.
shellcheck was referring to this tool: https://www.shellcheck.net/; the name of the script in hack needs to be something else. (Maybe devtools.sh? A little hard to express the difference between this and toolchain.sh ...)
tallaxes
added
area/developer-guide
* Add the step to run ./hack/toolchain.sh /usr/local/kubebuilder/bin /usr/local/kubebuilder/bin/k8s /usr/local/kubebuilder/bin/k8s/1.29.3-linux-amd64 /usr/local/kubebuilder/bin/k8s/1.29.3-linux-amd64/etcd /usr/local/kubebuilder/bin/k8s/1.29.3-linux-amd64/kube-apiserver /usr/local/kubebuilder/bin/k8s/1.29.3-linux-amd64/kubectl /usr/local/kubebuilder/bin/k8s/1.27.1-linux-amd64 /usr/local/kubebuilder/bin/k8s/1.27.1-linux-amd64/etcd /usr/local/kubebuilder/bin/k8s/1.27.1-linux-amd64/kube-apiserver /usr/local/kubebuilder/bin/k8s/1.27.1-linux-amd64/kubectl /usr/local/kubebuilder/bin/etcd /usr/local/kubebuilder/bin/kube-apiserver /usr/local/kubebuilder/bin/kubectl at the CONTRIBUTING.md
Fixes #
#56
Description
Added documentation for creating a local developer environment.
How was this change tested?
Only the document side has changed.
Does this change impact docs?
Release Note
None