hub-of-hubs-status-transport-bridge

README

Hub-of-Hubs Status Transport Bridge

The status transport bridge component of Hub-of-Hubs.

Go to the Contributing guide to learn how to get involved.

Getting Started

Build and push the image to docker registry

1. Set the REGISTRY environment variable to hold the name of your docker registry:

   $ export REGISTRY=...
   

2. Set the IMAGE_TAG environment variable to hold the required version of the image.
   default value is latest, so in that case no need to specify this variable:

   $ export IMAGE_TAG=latest
   

3. Run make to build and push the image:

   $ make push-images
   

Deploy on the hub of hubs

Set the DATABASE_URL according to the PostgreSQL URL format: postgres://YourUserName:YourURLEscapedPassword@YourHostname:5432/YourDatabaseName?sslmode=verify-full&pool_max_conns=50.

❗ Remember to URL-escape the password, you can do it in bash:

python -c "import sys, urllib as ul; print ul.quote_plus(sys.argv[1])" 'YourPassword'

1. Create a secret with your database url:

   kubectl create secret generic hub-of-hubs-database-transport-bridge-secret -n open-cluster-management --from-literal=url=$DATABASE_URL
   

2. Set the REGISTRY environment variable to hold the name of your docker registry:

   $ export REGISTRY=...
   

3. Set the IMAGE environment variable to hold the name of the image.

   $ export IMAGE=$REGISTRY/$(basename $(pwd)):latest
   

4. Set the TRANSPORT_TYPE environment variable to "kafka" or "sync-service" to set which transport to use.

   $ export TRANSPORT_TYPE=...
   

5. If you set sync-service as transport, set the following:

   1. Set the SYNC_SERVICE_HOST environment variable to hold the CSS host.

      $ export SYNC_SERVICE_HOST=...
      

   2. Set the SYNC_SERVICE_PORT environment variable to hold the CSS port.

      $ export SYNC_SERVICE_PORT=...
      

6. Run the following command to deploy the hub-of-hubs-status-transport-bridge to your hub of hubs cluster:

   envsubst < deploy/hub-of-hubs-status-transport-bridge.yaml.template | kubectl apply -f -
   

Cleanup from the hub of hubs

1. Run the following command to clean hub-of-hubs-status-transport-bridge from your hub of hubs cluster:

   envsubst < deploy/hub-of-hubs-status-transport-bridge.yaml.template | kubectl delete -f -