Advertisement documentation
Updated documentation with the splitting of advertisement controller and broadcaster
@@ -23,8 +23,8 @@ To modify the Advertisement you need to
### Test execution with KinD
You can simply test the system using KinD (https://github.com/kubernetes-sigs/kind/). We suggest to copy _test/kind_ folder in your local machine.
-Move to this folder and modify the file `kind.sh` with the IP address of your machine and the number of clusters you want to create.
-Run the script `./kind.sh`: it will create, configure and start n clusters with everything you need.
+Move to this folder and modify the file `kind.sh` with the number of clusters you want to create.
+Run the script `./kind.sh <ip_address>`, where `<ip_address>` is the local ip address of your machine (NOT the localhost): it will create, configure and start n clusters with everything you need.
### Run instructions
1. create a configMap for every foreign cluster you want to communicate with.
@@ -35,8 +35,10 @@ Apply it to the cluster `kubectl apply -f deployments/advertisement-operator/for
In _deployments/advertisement-operator_ folder there is a file _adv-operator_cm.yaml_ already set up, you only need to insert your cluster ID and some optional network information
Apply it to the cluster `kubectl apply -f deployments/advertisement-operator/adv-operator_cm.yaml`
3. run `make install -f scripts/advertisement-operator/Makefile` on both your home cluster and foreign one. This will install the CRD Advertisement
-4. run the operator
+4. run the advertisement broadcaster, which is in charge of creating an Advertisement CR on each foreign cluster
+ - outside a cluster: `go build cmd/advertisement-broadcaster/main.go --cluster-id <cluster_id>`, where <cluster-id> is the cluster ID of your home cluster
+ - inside a cluster: run `kubectl apply -f deployments/advertisement-broadcaster/broadcaster_deploy.yaml`
+5. run the advertisement controller, which is in charge of reconciling the status of the Advertisement CR and spawning the virtual-kubelet
- outside a cluster: `go build cmd/advertisement-operator/main.go --cluster-id <cluster_id>`, where <cluster-id> is the cluster ID of your home cluster
- - inside a cluster: run `kubectl apply -f deployments/adv_deploy.yaml`
-5. an Advertisement CR will be created on each foreign cluster (you can check with `kubectl get adv`)
+ - inside a cluster: run `kubectl apply -f deployments/advertisement-operator/adv_deploy.yaml`
6. repeat all the steps on your foreign cluster so that it starts sending its Advertisements to home cluster
\ No newline at end of file
