Skip to content

Commit

Permalink
Adapt docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremyharisch committed Jan 16, 2024
1 parent 4f356a0 commit 6804efe
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion cmd/kyma/provision/gardener/aws/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ func NewCmd(o *Options) *cobra.Command {
Short: "Provisions a Kubernetes cluster using Gardener on Amazon Web Services (AWS).",
Long: `Use this command to provision Kubernetes clusters with Gardener on AWS for Kyma installation.
To successfully provision a cluster on AWS, you must first create a service account to pass its details as one of the command parameters.
Check the roles and create a service account using instructions at https://gardener.cloud/050-tutorials/content/howto/gardener_aws/.
Check the roles and create a service account using instructions at https://gardener.cloud/docs/gardener/service-account-manager/.
Use service account details to create a Secret and import it in Gardener.`,

RunE: func(_ *cobra.Command, _ []string) error { return c.Run() },
Expand Down
2 changes: 1 addition & 1 deletion cmd/kyma/provision/gardener/gcp/cmd.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ func NewCmd(o *Options) *cobra.Command {
Short: "Provisions a Kubernetes cluster using Gardener on Google Cloud Platform (GCP).",
Long: `Use this command to provision Kubernetes clusters with Gardener on GCP for Kyma installation.
To successfully provision a cluster on GCP, you must first create a service account to pass its details as one of the command parameters.
Check the roles and create a service account using instructions at https://gardener.cloud/050-tutorials/content/howto/gardener_gcp/.
Check the roles and create a service account using instructions at https://gardener.cloud/docs/gardener/service-account-manager/.
Use service account details to create a Secret and import it in Gardener.`,

RunE: func(_ *cobra.Command, _ []string) error { return c.Run() },
Expand Down
4 changes: 2 additions & 2 deletions docs/gen-docs/kyma_provision_gardener_aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Provisions a Kubernetes cluster using Gardener on Amazon Web Services (AWS).

Use this command to provision Kubernetes clusters with Gardener on AWS for Kyma installation.
To successfully provision a cluster on AWS, you must first create a service account to pass its details as one of the command parameters.
Check the roles and create a service account using instructions at https://gardener.cloud/050-tutorials/content/howto/gardener_aws/.
Check the roles and create a service account using instructions at https://gardener.cloud/docs/gardener/service-account-manager/.
Use service account details to create a Secret and import it in Gardener.

```bash
Expand All @@ -27,7 +27,7 @@ kyma provision gardener aws [flags]
--hibernation-end string Cron expression to configure when the cluster should stop hibernating
--hibernation-location string Timezone in which the hibernation schedule should be applied. (default "Europe/Berlin")
--hibernation-start string Cron expression to configure when the cluster should start hibernating (default "00 18 * * 1,2,3,4,5")
-k, --kube-version string Kubernetes version of the cluster. (default "1.26")
-k, --kube-version string Kubernetes version of the cluster. (default "1.27")
-n, --name string Name of the cluster to provision. (required)
-p, --project string Name of the Gardener project where you provision the cluster. (required)
-r, --region string Region of the cluster. (default "eu-west-3")
Expand Down
2 changes: 1 addition & 1 deletion docs/gen-docs/kyma_provision_gardener_az.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ kyma provision gardener az [flags]
--hibernation-end string Cron expression to configure when the cluster should stop hibernating
--hibernation-location string Timezone in which the hibernation schedule should be applied. (default "Europe/Berlin")
--hibernation-start string Cron expression to configure when the cluster should start hibernating (default "00 18 * * 1,2,3,4,5")
-k, --kube-version string Kubernetes version of the cluster. (default "1.26")
-k, --kube-version string Kubernetes version of the cluster. (default "1.27")
-n, --name string Name of the cluster to provision. (required)
-p, --project string Name of the Gardener project where you provision the cluster. (required)
-r, --region string Region of the cluster. (default "westeurope")
Expand Down
4 changes: 2 additions & 2 deletions docs/gen-docs/kyma_provision_gardener_gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Provisions a Kubernetes cluster using Gardener on Google Cloud Platform (GCP).

Use this command to provision Kubernetes clusters with Gardener on GCP for Kyma installation.
To successfully provision a cluster on GCP, you must first create a service account to pass its details as one of the command parameters.
Check the roles and create a service account using instructions at https://gardener.cloud/050-tutorials/content/howto/gardener_gcp/.
Check the roles and create a service account using instructions at https://gardener.cloud/docs/gardener/service-account-manager/.
Use service account details to create a Secret and import it in Gardener.

```bash
Expand All @@ -27,7 +27,7 @@ kyma provision gardener gcp [flags]
--hibernation-end string Cron expression to configure when the cluster should stop hibernating
--hibernation-location string Timezone in which the hibernation schedule should be applied. (default "Europe/Berlin")
--hibernation-start string Cron expression to configure when the cluster should start hibernating (default "00 18 * * 1,2,3,4,5")
-k, --kube-version string Kubernetes version of the cluster. (default "1.26")
-k, --kube-version string Kubernetes version of the cluster. (default "1.27")
-n, --name string Name of the cluster to provision. (required)
-p, --project string Name of the Gardener project where you provision the cluster. (required)
-r, --region string Region of the cluster. (default "europe-west3")
Expand Down
2 changes: 1 addition & 1 deletion docs/gen-docs/kyma_provision_k3d.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ kyma provision k3d [flags]
--k3d-arg strings One or more arguments passed to the k3d provisioning command (e.g. --k3d-arg='--no-rollback')
--k3d-registry-arg strings One or more arguments passed to the k3d registry create command (e.g. --k3d-registry-arg='--default-network podman')
-s, --k3s-arg strings One or more arguments passed from k3d to the k3s command (format: ARG@NODEFILTER[;@NODEFILTER])
-k, --kube-version string Kubernetes version of the cluster (default "1.26.6")
-k, --kube-version string Kubernetes version of the cluster (default "1.27.9")
--name string Name of the Kyma cluster (default "kyma")
-p, --port strings Map ports 80 and 443 of K3D loadbalancer (e.g. -p 80:80@loadbalancer -p 443:443@loadbalancer) (default [80:80@loadbalancer,443:443@loadbalancer])
--registry-port string Specify the port on which the k3d registry will be exposed (default "5001")
Expand Down

0 comments on commit 6804efe

Please sign in to comment.