Skip to content

Commit

Permalink
Fixes in Makefile and *.md files (#863)
Browse files Browse the repository at this point in the history
* Add other "make dev-..." commands comments

* Fix providers related doc links

* Fix #create-a-clusterdeployment README link
  • Loading branch information
Josca authored Jan 7, 2025
1 parent 0adc43f commit b785be7
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -370,15 +370,15 @@ test-apply: set-hmc-version helm-package dev-deploy dev-templates dev-release
dev-destroy: kind-undeploy registry-undeploy ## Destroy the development environment by deleting the kind cluster and local registry.

.PHONY: dev-mcluster-apply
dev-mcluster-apply: envsubst
dev-mcluster-apply: envsubst ## Create dev managed cluster using 'config/dev/$(DEV_PROVIDER)-clusterdeployment.yaml'
@NAMESPACE=$(NAMESPACE) $(ENVSUBST) -no-unset -i config/dev/$(DEV_PROVIDER)-clusterdeployment.yaml | $(KUBECTL) apply -f -

.PHONY: dev-mcluster-delete
dev-mcluster-delete: envsubst
dev-mcluster-delete: envsubst ## Delete dev managed cluster using 'config/dev/$(DEV_PROVIDER)-clusterdeployment.yaml'
@NAMESPACE=$(NAMESPACE) $(ENVSUBST) -no-unset -i config/dev/$(DEV_PROVIDER)-clusterdeployment.yaml | $(KUBECTL) delete -f -

.PHONY: dev-creds-apply
dev-creds-apply: dev-$(DEV_PROVIDER)-creds
dev-creds-apply: dev-$(DEV_PROVIDER)-creds ## Create credentials resources for $DEV_PROVIDER

.PHONY: dev-aws-nuke
dev-aws-nuke: envsubst awscli yq cloud-nuke ## Warning: Destructive! Nuke all AWS resources deployed by 'DEV_PROVIDER=aws dev-mcluster-apply'
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ or install using `helm`
helm install hmc oci://ghcr.io/k0rdent/kcm/charts/hmc --version 0.0.6 -n hmc-system --create-namespace
```

Then follow the [Deploy a cluster deployment](#deploy-a-cluster-deployment) guide to
Then follow the [Deploy a cluster deployment](#create-a-clusterdeployment) guide to
create a cluster deployment.

> [!NOTE]
Expand Down
6 changes: 3 additions & 3 deletions docs/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ make cli-install

### AWS Provider Setup

Follow the instruction to configure AWS Provider: [AWS Provider Setup](aws/main.md#prepare-the-aws-infra-provider)
Follow the instruction to configure AWS Provider: [AWS Provider Setup](https://k0rdent.github.io/docs/quick-start/aws/)

The following env variables must be set in order to deploy dev cluster on AWS:

Expand All @@ -36,7 +36,7 @@ The following environment variables are optional but can enhance functionality:

### Azure Provider Setup

Follow the instruction on how to configure [Azure Provider](azure/main.md).
Follow the instruction on how to configure [Azure Provider](https://k0rdent.github.io/docs/quick-start/azure/).

Additionally to deploy dev cluster on Azure the following env variables should
be set before running deployment:
Expand All @@ -51,7 +51,7 @@ More detailed description of these parameters can be found

### vSphere Provider Setup

Follow the instruction on how to configure [vSphere Provider](vsphere/main.md).
Follow the instruction on how to configure [vSphere Provider](https://k0rdent.github.io/docs/quick-start/vsphere/).

To properly deploy dev cluster you need to have the following variables set:

Expand Down

0 comments on commit b785be7

Please sign in to comment.