From 51bbc930c54e36a38c836a88266f98aa392c1e81 Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Mon, 23 Sep 2024 10:27:00 +0200 Subject: [PATCH 1/8] update quick install --- docs/02-get-started/01-quick-install.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/02-get-started/01-quick-install.md b/docs/02-get-started/01-quick-install.md index 426e70686518..0526fc3519e2 100644 --- a/docs/02-get-started/01-quick-install.md +++ b/docs/02-get-started/01-quick-install.md @@ -17,7 +17,7 @@ To get started with Kyma, let's quickly install it with specific modules first. 1. To provision a k3d cluster, run: ```bash - k3d cluster create --k3s-arg '--tls-san=host.docker.internal@server:*' + k3d cluster create -p '80:80@loadbalancer' -p '443:443@loadbalancer' --k3s-arg '--disable=traefik@server:*' --k3s-arg '--tls-san=host.docker.internal@server:*' kubectl create ns kyma-system ``` @@ -90,8 +90,25 @@ To get started with Kyma, let's quickly install it with specific modules first. kubectl apply -f https://github.com/kyma-project/api-gateway/releases/latest/download/api-gateway-manager.yaml kubectl apply -f https://github.com/kyma-project/api-gateway/releases/latest/download/apigateway-default-cr.yaml ``` + +3. Update Core DNS to correctly resolve the `local.kyma.dev` domain: + + ```bash + cat < Date: Mon, 23 Sep 2024 10:30:36 +0200 Subject: [PATCH 2/8] fix typo --- docs/02-get-started/01-quick-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-get-started/01-quick-install.md b/docs/02-get-started/01-quick-install.md index 0526fc3519e2..4b28009c68fa 100644 --- a/docs/02-get-started/01-quick-install.md +++ b/docs/02-get-started/01-quick-install.md @@ -91,7 +91,7 @@ To get started with Kyma, let's quickly install it with specific modules first. kubectl apply -f https://github.com/kyma-project/api-gateway/releases/latest/download/apigateway-default-cr.yaml ``` -3. Update Core DNS to correctly resolve the `local.kyma.dev` domain: +3. Update CoreDNS to correctly resolve the `local.kyma.dev` domain: ```bash cat < Date: Mon, 23 Sep 2024 10:45:57 +0200 Subject: [PATCH 3/8] add kubeconfig-switch-context --- docs/02-get-started/01-quick-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-get-started/01-quick-install.md b/docs/02-get-started/01-quick-install.md index 4b28009c68fa..83fe1117dfc9 100644 --- a/docs/02-get-started/01-quick-install.md +++ b/docs/02-get-started/01-quick-install.md @@ -17,7 +17,7 @@ To get started with Kyma, let's quickly install it with specific modules first. 1. To provision a k3d cluster, run: ```bash - k3d cluster create -p '80:80@loadbalancer' -p '443:443@loadbalancer' --k3s-arg '--disable=traefik@server:*' --k3s-arg '--tls-san=host.docker.internal@server:*' + k3d cluster create kyma --kubeconfig-switch-context -p '80:80@loadbalancer' -p '443:443@loadbalancer' --k3s-arg '--disable=traefik@server:*' --k3s-arg '--tls-san=host.docker.internal@server:*' kubectl create ns kyma-system ``` From f7db95d7bdbdfbeabd2e8703384eed47947c6a65 Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Mon, 23 Sep 2024 12:22:56 +0200 Subject: [PATCH 4/8] add note --- docs/02-get-started/01-quick-install.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/02-get-started/01-quick-install.md b/docs/02-get-started/01-quick-install.md index 83fe1117dfc9..1ff4fa12bf80 100644 --- a/docs/02-get-started/01-quick-install.md +++ b/docs/02-get-started/01-quick-install.md @@ -20,6 +20,8 @@ To get started with Kyma, let's quickly install it with specific modules first. k3d cluster create kyma --kubeconfig-switch-context -p '80:80@loadbalancer' -p '443:443@loadbalancer' --k3s-arg '--disable=traefik@server:*' --k3s-arg '--tls-san=host.docker.internal@server:*' kubectl create ns kyma-system ``` + >[!NOTE] + > If ports `80` and `443` are already in use on your host, change the command to map different ports from the host to ports `80` and `443` on the cluster's load balancer container. For example, `'30080:80@loadbalancer' -p '30443:443@loadbalancer'`. 1. To install a Kyma module of your choice on a Kubernetes cluster, deploy its module manager and apply the module configuration. See the following Kyma modules with their quick installation commands and links to their GitHub repositories: From 8aa914f4abcc8d4bcce466723143925e25a2d66c Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Mon, 23 Sep 2024 13:50:06 +0200 Subject: [PATCH 5/8] fix formatting --- docs/02-get-started/01-quick-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-get-started/01-quick-install.md b/docs/02-get-started/01-quick-install.md index 1ff4fa12bf80..5614d6fb8404 100644 --- a/docs/02-get-started/01-quick-install.md +++ b/docs/02-get-started/01-quick-install.md @@ -21,7 +21,7 @@ To get started with Kyma, let's quickly install it with specific modules first. kubectl create ns kyma-system ``` >[!NOTE] - > If ports `80` and `443` are already in use on your host, change the command to map different ports from the host to ports `80` and `443` on the cluster's load balancer container. For example, `'30080:80@loadbalancer' -p '30443:443@loadbalancer'`. + > If ports `80` and `443` are already in use on your host, change the command to map different ports from the host to ports `80` and `443` on the cluster's `loadbalancer` container. For example, `-p '30080:80@loadbalancer' -p '30443:443@loadbalancer'`. 1. To install a Kyma module of your choice on a Kubernetes cluster, deploy its module manager and apply the module configuration. See the following Kyma modules with their quick installation commands and links to their GitHub repositories: From 0d618212380f3d6c0914764f3cac8d587b88ff65 Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Tue, 24 Sep 2024 09:41:23 +0200 Subject: [PATCH 6/8] fix steps numbers --- docs/02-get-started/01-quick-install.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/02-get-started/01-quick-install.md b/docs/02-get-started/01-quick-install.md index 5614d6fb8404..c9420ff18009 100644 --- a/docs/02-get-started/01-quick-install.md +++ b/docs/02-get-started/01-quick-install.md @@ -21,9 +21,9 @@ To get started with Kyma, let's quickly install it with specific modules first. kubectl create ns kyma-system ``` >[!NOTE] - > If ports `80` and `443` are already in use on your host, change the command to map different ports from the host to ports `80` and `443` on the cluster's `loadbalancer` container. For example, `-p '30080:80@loadbalancer' -p '30443:443@loadbalancer'`. + > If ports `80` and `443` are already in use on your host, change the command to map different ports from the host to ports `80` and `443` on the cluster's loadbalancer container. For example, `-p '30080:80@loadbalancer' -p '30443:443@loadbalancer'`. -1. To install a Kyma module of your choice on a Kubernetes cluster, deploy its module manager and apply the module configuration. See the following Kyma modules with their quick installation commands and links to their GitHub repositories: +2. To install a Kyma module of your choice on a Kubernetes cluster, deploy its module manager and apply the module configuration. See the following Kyma modules with their quick installation commands and links to their GitHub repositories: [**Istio**](https://github.com/kyma-project/istio) From b7a364030e95f0ba66214db717383ed8ed089a38 Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Mon, 7 Oct 2024 08:08:10 +0200 Subject: [PATCH 7/8] update ports --- docs/02-get-started/01-quick-install.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/02-get-started/01-quick-install.md b/docs/02-get-started/01-quick-install.md index c9420ff18009..8b9cdb36a12e 100644 --- a/docs/02-get-started/01-quick-install.md +++ b/docs/02-get-started/01-quick-install.md @@ -17,13 +17,13 @@ To get started with Kyma, let's quickly install it with specific modules first. 1. To provision a k3d cluster, run: ```bash - k3d cluster create kyma --kubeconfig-switch-context -p '80:80@loadbalancer' -p '443:443@loadbalancer' --k3s-arg '--disable=traefik@server:*' --k3s-arg '--tls-san=host.docker.internal@server:*' + k3d cluster create kyma --kubeconfig-switch-context -p '30080:80@loadbalancer' -p '30443:443@loadbalancer' --k3s-arg '--disable=traefik@server:*' --k3s-arg '--tls-san=host.docker.internal@server:*' kubectl create ns kyma-system ``` >[!NOTE] - > If ports `80` and `443` are already in use on your host, change the command to map different ports from the host to ports `80` and `443` on the cluster's loadbalancer container. For example, `-p '30080:80@loadbalancer' -p '30443:443@loadbalancer'`. + > If ports `30080` and `30443` are already in use on your host, change the command to map different ports from the host to ports `80` and `443` on the cluster's loadbalancer container. -2. To install a Kyma module of your choice on a Kubernetes cluster, deploy its module manager and apply the module configuration. See the following Kyma modules with their quick installation commands and links to their GitHub repositories: +1. To install a Kyma module of your choice on a Kubernetes cluster, deploy its module manager and apply the module configuration. See the following Kyma modules with their quick installation commands and links to their GitHub repositories: [**Istio**](https://github.com/kyma-project/istio) From c1f97ec00e5d2fe9fcdd837e2a4444046ff320ea Mon Sep 17 00:00:00 2001 From: nataliasitko Date: Mon, 7 Oct 2024 08:09:10 +0200 Subject: [PATCH 8/8] fix numbering --- docs/02-get-started/01-quick-install.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/02-get-started/01-quick-install.md b/docs/02-get-started/01-quick-install.md index 8b9cdb36a12e..0ff5513dd912 100644 --- a/docs/02-get-started/01-quick-install.md +++ b/docs/02-get-started/01-quick-install.md @@ -20,10 +20,8 @@ To get started with Kyma, let's quickly install it with specific modules first. k3d cluster create kyma --kubeconfig-switch-context -p '30080:80@loadbalancer' -p '30443:443@loadbalancer' --k3s-arg '--disable=traefik@server:*' --k3s-arg '--tls-san=host.docker.internal@server:*' kubectl create ns kyma-system ``` - >[!NOTE] - > If ports `30080` and `30443` are already in use on your host, change the command to map different ports from the host to ports `80` and `443` on the cluster's loadbalancer container. -1. To install a Kyma module of your choice on a Kubernetes cluster, deploy its module manager and apply the module configuration. See the following Kyma modules with their quick installation commands and links to their GitHub repositories: +2. To install a Kyma module of your choice on a Kubernetes cluster, deploy its module manager and apply the module configuration. See the following Kyma modules with their quick installation commands and links to their GitHub repositories: [**Istio**](https://github.com/kyma-project/istio)