Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🌱 fix some typos in the syncer documentation #2927

Merged
merged 2 commits into from
Mar 28, 2023
Merged

🌱 fix some typos in the syncer documentation #2927

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ef751e
fix some typos
lionelvillard Mar 28, 2023
06f5832
changes after review
lionelvillard Mar 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 20 additions & 19 deletions docs/content/concepts/registering-kubernetes-clusters-using-syncer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To register a Kubernetes cluster with kcp, you have to install a special compone
!!! note
This step sets current context to the new kind cluster. Make sure to use a KCP kubeconfig for the next steps unless told otherwise.

1. Create an organisation and immediately enter it:
1. Create an organization and immediately enter it:

```sh
$ kubectl kcp workspace create my-org --enter
Expand All @@ -40,15 +40,15 @@ To register a Kubernetes cluster with kcp, you have to install a special compone
Current workspace is "root:my-org" (type "root:organization").
```

1. Enable the syncer for a p-cluster:
1. Enable the syncer for a physical cluster:

```sh
kubectl kcp workload sync <synctarget name> --syncer-image <image name> -o syncer.yaml
```

Where `<image name>` [one of the syncer images](/~https://github.com/kcp-dev/kcp/pkgs/container/kcp%2Fsyncer) for your corresponding KCP release (e.g. `ghcr.io/kcp-dev/kcp/syncer:v0.7.5`).

1. Apply the manifest to the p-cluster:
1. Apply the manifest to the physical cluster:

```sh
$ KUBECONFIG=<pcluster-config> kubectl apply -f syncer.yaml
Expand All @@ -61,53 +61,54 @@ To register a Kubernetes cluster with kcp, you have to install a special compone
deployment.apps/kcp-syncer-kind-1owee1ci created
```

and it will create a `kcp-syncer` deployment:
and it will create a `kcp-syncer-<synctarget name>-xx` deployment:

```sh
$ KUBECONFIG=<pcluster-config> kubectl -n kcp-syncer-kind-1owee1ci get deployments
NAME READY UP-TO-DATE AVAILABLE AGE
kcp-syncer 1/1 1 1 13m
NAME READY UP-TO-DATE AVAILABLE AGE
kcp-syncer-<synctarget name>-xx 1/1 1 1 13m
```

1. Wait for the kcp sync target to go ready:

```bash
kubectl wait --for=condition=Ready synctarget/<mycluster>
```
### Select resources to sync.

Syncer will by default use the `kubernetes` APIExport in `root:compute` workspace and sync `deployments/services/ingresses`
to the physical cluster. The related API schemas of the physical cluster should be comptible with kubernetes 1.24. User can
select to sync other resources in physical clusters or from other APIExports on kcp server.
### Select resources to synchronize.

Syncer will by default use the `kubernetes` APIExport in `root:compute` workspace and synchronize `deployments/services/ingresses/pods`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC pod is only upsynced. Also, there's a PR open to change from kubernetes #2877 @qiujian16 can you update the doc as well please

to the physical cluster. The related API schemas of the physical cluster should be compatible with kubernetes 1.24. User can
select to synchronize other resources in physical clusters or from other APIExports on kcp server.

To sync resources that the KCP server does not have an APIExport to support yet, run
To synchronize resources that the KCP server does not have an APIExport to support yet, run

```sh
kubectl kcp workload sync <mycluster> --syncer-image <image name> --resources foo.bar -o syncer.yaml
```

Make sure to have the resource name in the form of `resourcename.<gvr_of_the_resource>` to be able to
sync succesfully to the physical cluster.
synchronize successfully to the physical cluster.

For example to sync resource `routes` to physical cluster run the command below
For example to synchronize resource `routes` to physical cluster run the command below

```sh
kubectl kcp workload sync <mycluster> --syncer-image <image name> --resources routes.route.openshift.io -o syncer.yaml
```

And apply the generated manifests to the physical cluster. The syncer will then import the API schema of foo.bar
to the workspace of the synctarget, following up with an auto generated kubernetes APIExport/APIBinding in the same workspace.
You can then create foo.bar in this workspace, or create an APIBinding in another workspace to bind this APIExport.
And apply the generated manifests to the physical cluster. The syncer will then import the API schema of `foo.bar`
to the workspace of the SyncTarget, followed by an auto generated kubernetes APIExport and APIBinding in the same workspace.
You can then create `foo.bar` in this workspace, or create an APIBinding in another workspace to bind this APIExport.

To sync resource from another existing APIExport in the KCP server, run
To synchronize resource from another existing APIExport in the KCP server, run

```sh
kubectl kcp workload sync <mycluster> --syncer-image <image name> --apiexports another-workspace:another-apiexport -o syncer.yaml
```

Syncer will start syncing the resources in this `APIExport` as long as the `SyncTarget` has compatible API schemas.
Syncer will start synchronizing the resources in this `APIExport` as long as the `SyncTarget` has compatible API schemas.

To see if a certain resource is supported to be synced by the syncer, you can check the state of the `syncedResources` in `SyncTarget`
To see if a certain resource is synchronized by the syncer, you can check the state of the `syncedResources` in `SyncTarget`
status.

### Bind workspaces to the Location Workspace
Expand Down