From 6776a54988ac31f2650ec2a61b20976db133a66c Mon Sep 17 00:00:00 2001 From: Burak Sekili <32663655+buraksekili@users.noreply.github.com> Date: Wed, 26 Feb 2025 11:33:05 +0300 Subject: [PATCH 1/4] Update README.md fix the incorrect link Signed-off-by: Burak Sekili <32663655+buraksekili@users.noreply.github.com> --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 2120864..fa6d63a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -109,7 +109,7 @@ able to delete and recreate objects to follow this GVK change, which is a level simply do not want to deal with at this point in time. Also, `APIResourceSchemas` are immutable themselves. -More information is available in the [Publishing Resources][publish-resources.md] guide. +More information is available in the [Publishing Resources](./publish-resources.md) guide. ### APIExports From 256f3ac87af20263cd87e1cff28a194c974c8497 Mon Sep 17 00:00:00 2001 From: Burak Sekili <32663655+buraksekili@users.noreply.github.com> Date: Wed, 26 Feb 2025 12:01:04 +0300 Subject: [PATCH 2/4] add a flag to create ns if not exists Signed-off-by: Burak Sekili <32663655+buraksekili@users.noreply.github.com> --- docs/getting-started.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 02a461d..ed7cea4 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -90,7 +90,8 @@ helm repo update helm install kcp-api-syncagent kcp/api-syncagent \ --values values.yaml \ - --namespace kcp-system + --namespace kcp-system \ + --create-namespace ``` Two `kcp-api-syncagent` Pods should start in the `kcp-system` namespace. If they crash you will need to From e9222ecfc34dc4b36b124ca59a1447bd03f98da4 Mon Sep 17 00:00:00 2001 From: Burak Sekili <32663655+buraksekili@users.noreply.github.com> Date: Wed, 26 Feb 2025 12:07:23 +0300 Subject: [PATCH 3/4] update discrepancy in the docs Signed-off-by: Burak Sekili <32663655+buraksekili@users.noreply.github.com> --- docs/getting-started.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index ed7cea4..d876af4 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -90,11 +90,10 @@ helm repo update helm install kcp-api-syncagent kcp/api-syncagent \ --values values.yaml \ - --namespace kcp-system \ - --create-namespace + --namespace k8c-system ``` -Two `kcp-api-syncagent` Pods should start in the `kcp-system` namespace. If they crash you will need to +Two `kcp-api-syncagent` Pods should start in the `k8c-system` namespace. If they crash you will need to identify the reason from container logs. A possible issue is that the provided kubeconfig does not have permissions against the target kcp workspace. @@ -136,7 +135,7 @@ roleRef: subjects: - kind: ServiceAccount name: 'kcp-api-syncagent' - namespace: kcp-system + namespace: k8c-system ``` **NB:** Even though the PublishedResources might only create/update Certificates in a single namespace, From 4542099d78255259d0657c774bb3a4c55f909185 Mon Sep 17 00:00:00 2001 From: Burak Sekili <32663655+buraksekili@users.noreply.github.com> Date: Wed, 26 Feb 2025 13:17:02 +0300 Subject: [PATCH 4/4] rename k8c to kcp Signed-off-by: Burak Sekili <32663655+buraksekili@users.noreply.github.com> --- docs/getting-started.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index d876af4..e473b37 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -41,7 +41,7 @@ apiexport/test.example.com created ## Sync Agent Installation -The Sync Agent can be installed into any namespace, but in our example we are going with `k8c-system`. +The Sync Agent can be installed into any namespace, but in our example we are going with `kcp-system`. It doesn't necessarily have to live in the same Kubernetes cluster where it is synchronizing data to, but that is the common setup. Ultimately the Sync Agent synchronizes data between two kube endpoints. @@ -55,7 +55,7 @@ This can be done via a command like this: ```sh $ kubectl create secret generic kcp-kubeconfig \ - --namespace k8c-system \ + --namespace kcp-system \ --from-file "kubeconfig=admin.kubeconfig" ``` @@ -90,10 +90,10 @@ helm repo update helm install kcp-api-syncagent kcp/api-syncagent \ --values values.yaml \ - --namespace k8c-system + --namespace kcp-system ``` -Two `kcp-api-syncagent` Pods should start in the `k8c-system` namespace. If they crash you will need to +Two `kcp-api-syncagent` Pods should start in the `kcp-system` namespace. If they crash you will need to identify the reason from container logs. A possible issue is that the provided kubeconfig does not have permissions against the target kcp workspace. @@ -135,7 +135,7 @@ roleRef: subjects: - kind: ServiceAccount name: 'kcp-api-syncagent' - namespace: k8c-system + namespace: kcp-system ``` **NB:** Even though the PublishedResources might only create/update Certificates in a single namespace,