Chapter 11. Configuring Skupper sites using YAML

1. Create backend.yaml similar to the following:

   apiVersion: v1
   kind: Service
   metadata:
     name: backend
     annotations:
       skupper.io/proxy: tcp
       skupper.io/address: backend
       skupper.io/port: "8080"
       skupper.io/ingress-only: "true"
   spec:
     ports:
       - name: http
         protocol: TCP
         port: 8080
         targetPort: 8080

   Copy to Clipboard Toggle word wrap
   Note

   The skupper.io/address annotation must match the service name you have previously exposed on another site.

2. Apply that yaml in the context of the site where service-sync is disabled:

   $ kubectl apply -f backend.yaml

   Copy to Clipboard Toggle word wrap
3. Test the service.

Procedure

1. Log into the namespace in your cluster that is configured as a site.

2. Create a deployment, some pods, or a service in one of your sites, for example:

   $ kubectl create deployment hello-world-backend --image quay.io/skupper/hello-world-backend

   Copy to Clipboard Toggle word wrap

   This step is not Skupper-specific, that is, this process is unchanged from standard processes for your cluster.

3. Annotate the kubernetes resource to create a service that can communicate on the service network, for example:

   $ kubectl annotate deployment backend "skupper.io/address=backend" "skupper.io/port=8080" "skupper.io/proxy=tcp"

   Copy to Clipboard Toggle word wrap

   The annotations include:

   • skupper.io/proxy - the protocol you want to use, tcp, http or http2. This is the only annotation that is required. For example, if you annotate a simple deployment named backend with skupper.io/proxy=tcp, the service is exposed as backend and the containerPort value of the deployment is used as the port number.
   • skupper.io/address - the name of the service on the service network.
   • skupper.io/port - one or more ports for the service on the service network.
   Note

   When exposing services, rather than other resources like deployments, you can use the skupper.io/target annotation to avoid modifying the original service. For example, if you want to expose the backend service:

   $ kubectl annotate service backend "skupper.io/address=van-backend" "skupper.io/port=8080" \
   "skupper.io/proxy=tcp" "skupper.io/target=backend"

   Copy to Clipboard Toggle word wrap

   This allows you to delete and recreate the backend service without having to apply the annotation again.

4. Check that you have exposed the service:

   $ skupper service status -v
   Services exposed through Skupper:
   ╰─ backend:8080 (tcp)
      ╰─ Sites:
         ├─ 4d80f485-52fb-4d84-b10b-326b96e723b2(west)
         │  policy: disabled
         ╰─ 316fbe31-299b-490b-9391-7b46507d76f1(east)
            │ policy: disabled
            ╰─ Targets:
               ╰─ backend:8080 name=backend-9d84544df-rbzjx

   Copy to Clipboard Toggle word wrap
   Note

   The related targets for services are only displayed when the target is available on the current cluster.