Skip to content

How to connect a Dock to a Hub

Target Audience

  • Administrators

Create a new Dock

  1. Open your Sleeve Hub interface and log in.
  2. Navigate to the Docks page by clicking the button.
Image

img: Settings button

  1. In the top menu bar labeled Docks click the button.
Image

img: Settings button

  1. Set the initialization fields according to your needs and click the create button.
  1. After creating the Dock click the Regenerate Secrets and Download Config button. This will download a file called env.yaml. Now press the top right Save button.

img: Regenerate Secrets and Download Config

img: Save

  1. Copy the env.yaml file into the ~/sleeve/ directory of the user that will be running the Sleeve Dock.

  2. Install the Sleeve Dock system on the desired host as described in How to install a Sleeve Dock.

On the next startup of the Sleeve Dock service, it will automatically connect to your Sleeve Hub instance.

Adapting the Dock Configuration

If the Sleeve Dock is connecting to the Sleeve Hub through a proxy, you may need to adapt the config. Open the downloaded env.yaml file in a text editor and change SLEEVE_TUNNEL_SERVER_ENDPOINT to the domain name of the Hub instance. If the Hub is being evaluated locally, use the container name instead.

Example: External Sleeve Hub

Let’s assume that the URL of your Hub is https://sleeve-hub.example.com, then you would set SLEEVE_TUNNEL_SERVER_ENDPOINT to sleeve-hub.example.com.

DNS env.yaml Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
apiVersion: "v1"
kind: "ConfigMap"
metadata:
name: "sleeve-dock-environment"
data:
   SLEEVE_USE_TUNNEL: true
   SLEEVE_TUNNEL_SERVER_ENDPOINT: "sleeve-hub.example.com"
   SLEEVE_TUNNEL_SERVER_PUBLIC_KEY: "koYrG/o7gr3MfgnwbTgEasu9cG6Wzi5OgOXHQ/oT20k="
   SLEEVE_DOCK_ID: "bUbiKAhQLU"
   SLEEVE_TUNNEL_CLIENT_IP: "10.0.224.98"
   SLEEVE_TUNNEL_CLIENT_PRIVATE_KEY: "f48UZm4z3mJA7QgM9ApkcFRUX9Fyracsq2mzmQTa5ZQ="
   SLEEVE_TUNNEL_CLIENT_PUBLIC_KEY: "3ysai9jCF1imXbdKysZD7EEpsiqi+/GvCtWYt8lIiSw="
   SLEEVE_TLS_CA_CERTIFICATE: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN1VENDQWFHZ0F3SUJBZ0lFcVZWb2tUQU5CZ2txaGtpRzl3MEJBUXNGQURBVU1SSXdFQVlEVlFRRERBbHMKYjJOaGJHaHZjM1F3SGhjTk1qTXdOREU0TVRrMU56STBXaGNOTkRNd05ERXpNVGsxTnpJMFdqQVVNUkl3RUFZRApWUVFEREFsc2IyTmhiR2h2YzNRd2dnRWlNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0SUJEd0F3Z2dFS0FvSUJBUURXCkpiQVZ3eWFhNUV2N2V1WEljVTBKWXc2NHRwTTk4L0xER2tZeWRoc05tMEM2Q3oxb2VPR2Fya1RpVG10ZlhDZUsKU2RXRm1KUnBySXljRVVMdFYza2ZvNVJkVG5ZUWNlNDV0Z2Fxd3NRN1Fsa1dnOXVucHo4bEVkdHUxVjExWEdKegphR2t2NDVaR21nYUxvdTlHeEg4c0hXVWRPbmlzd1RtejJOQVZGaUNjMEhGOWtoV0lNRWdJUXJlVHc1Z3JoaHBJCkhKQVFPMXBOSzc5TW8wK0tpQlpIWHFDNWNYMm9CdmRvOVpNUDVyZHQ3QlVYSXNPZXYrK28yVDM4TGF2OVRSS3oKL0pDcGVPMkYxWnNhS3JzWmFiakY0UlRiaHlqMSszdEJwNUNGWkJETzVHVXNkZ0dZOEkwd1VDRjdLRjB3SFA0Sgo2S2c2QytrZnVmK2dHWHJvbms1aEFnTUJBQUdqRXpBUk1BOEdBMVVkRXdFQi93UUZNQU1CQWY4d0RRWUpLb1pJCmh2Y05BUUVMQlFBRGdnRUJBS3FKN3NjU2NtWVJsUVUvM3U4VHFyZ25oYlFhR3U0eEpMTENSRFgwWlcvTHVqZUcKMEVDaENDeUkyWFFlY0tSb3VoaXRkaFcyeTRXdkdtZXQxcUhEMDdWOWFmREpkaG9Md01zVDZZM0l3L2l2Sk0rQwpmU0ZjTkdVbE1UQ1N5NkpLS2NrVjVZN05HV2wrWWZkdVYzYzNQbzlncnVmMy9OS3dHUkdjUTc1c1hOWDFQSzVPCk1WYjltcG5ISlZ1ZHZORmRQUklpL3JjQW5oM3dRV1VXazZiOWcrTXErN203R1lvMHBJc241RUtnbm5YellGM0cKUmVmQWNZZjBONUN0NGRHM01aSll0N2NtNFNrVE9RN0JsYjk3NVc5dVpIdlNucHFLRWlHMXdDTVVQKzlOczFIbworeTgzMStyaTk5WWlXMC9xRm5xWVJYN1k0bGlYR0xWZjRocHBmOHM9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K"
   SLEEVE_TLS_CERTIFICATE: "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUNwVENDQVkyZ0F3SUJBZ0lFUytLY2pqQU5CZ2txaGtpRzl3MEJBUXNGQURBVU1SSXdFQVlEVlFRRERBbHMKYjJOaGJHaHZjM1F3SGhjTk1qUXdNVEl5TVRjME16QTJXaGNOTXpRd01URTVNVGMwTXpBMldqQVZNUk13RVFZRApWUVFEREFwaVZXSnBTMEZvVVV4Vk1JSUJJakFOQmdrcWhraUc5dzBCQVFFRkFBT0NBUThBTUlJQkNnS0NBUUVBCnBlVXNSQW1ET3EzUWpXOVlmUlp4em53WE0ydnBoUVlGNUprZlcwSXQ1VGFYa3JzYVl6c0gzSkRDdUpWVmtLWDUKQzdnLzhFWUhzWllvNS9qZFVuZ0RnTE5mQmttWU1CQzZDVkdYQ0NzZHlhdzIxNnZUVFRTR2N4WDZQYU5Zc0tNUQo5ZlhSaE9lNFlKVEloRzlPUXpLZlF1R3I5QUZJMDlkV25xdVFsQkprOFdhZUx4Z3hNRGtUZWZzamJSN3BtMHVUClczRU5NWnRWTnNCditCQjhIR055Zy94eXFtYlBNeTJGWFpWNGVjbi95UkdMT29kM2dmQWxDY0MxVjlTc01KdnUKZGlEUUdoajAwNzM0cVVrWGNodmNyRldZb21HSTliQnZOckdLTkJtRTJtNCtJUm1mQXp3YmkwT1krOExqdFdZRAp2K3h2MDk3WWIzcHdPZTNsVmlSRFB3SURBUUFCTUEwR0NTcUdTSWIzRFFFQkN3VUFBNElCQVFDOWpaNHB3VlZlCk1JSzBDOWJIci90NTVENGJOQS95L1o4VDZDbHY5TTZCdXEzVis5YUozOWJveXEwTDlQMlJCWUN0clFISkh0VHEKdVRsY2dXWm1oOUFlTkZiVHIxNFpMaWtDMU5HMnF4WldzMURvNWw3UXZOcy9nWkZ5MlhBRThUYmkrazczS0hmNAp5UFUydnRGRlhKazdWdEo4UzJseDM2VStSZG1XenFzelg4ckR3V0pSZnpPUFVEYytCVEwzSHpFczYrM3gyRmd4CkZ4SDdrb0JiaHZvTXhISlFsRnFyL0xaUjFYcFFwaGxkQVFhbHBUcGY5RFhhSmhzYlpXdDFvSHhPWEJ2NVNjdHkKQnJOc1FvZnNiSyt1YzY3RFYrbGQxVnZXZ2UvWTd5VHA3SnoyZXlEcWQzTkpKSFl0Wm5DVXZ1ckRHczdoOGtEdwo2OUVpQlM0SEJueDgKLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo="
   SLEEVE_TLS_PRIVATE_KEY: "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFb3dJQkFBS0NBUUVBcGVVc1JBbURPcTNRalc5WWZSWnh6bndYTTJ2cGhRWUY1SmtmVzBJdDVUYVhrcnNhCll6c0gzSkRDdUpWVmtLWDVDN2cvOEVZSHNaWW81L2pkVW5nRGdMTmZCa21ZTUJDNkNWR1hDQ3NkeWF3MjE2dlQKVFRTR2N4WDZQYU5Zc0tNUTlmWFJoT2U0WUpUSWhHOU9RektmUXVHcjlBRkkwOWRXbnF1UWxCSms4V2FlTHhneApNRGtUZWZzamJSN3BtMHVUVzNFTk1adFZOc0J2K0JCOEhHTnlnL3h5cW1iUE15MkZYWlY0ZWNuL3lSR0xPb2QzCmdmQWxDY0MxVjlTc01KdnVkaURRR2hqMDA3MzRxVWtYY2h2Y3JGV1lvbUdJOWJCdk5yR0tOQm1FMm00K0lSbWYKQXp3YmkwT1krOExqdFdZRHYreHYwOTdZYjNwd09lM2xWaVJEUHdJREFRQUJBb0lCQUR2N3c4Z3NDbHVldW5CUgphTlQ5MXhPYWtjY0JoMU9XYkc0T0lhVGRKbndoQTZoRjU5SW1aMzdNaHVPMzkxTFFlRjdROWFsNm9OQ0k0MnlRCjh2R2RQR0wrT0djdEdBNlZGYmRGM1k3U0REaStBS3gxei9hei9jTkNHSlBONnNVZmlRUHVLSjVlTExBYlMrOTYKMFhrQnBrMUlET1V5eTdMeFF6d20rNlZXaTFJdlBBcE1BKzg5ZHdjd2ZkL2lHRjdxeDZKVWpNMnU5M3N5SHNiZQo5MFNyVjVOSWJXeHdUaUZSdDZ0VVBpR3hNSHpHZEE3WXM0RGZnRFY5WlplenhQS3FveXY5aGlYLzRuYkNPczhUCkJ1UXlsQ3lwUndCVE1meUxqU1RZdkV3K2tnNjNGZHhsZ1dqWlRPZTNaVzlCck9FVUd1NWQrNTlYbVBpVlpDS1EKN08yQWpCRUNnWUVBeXdsOGlQNGxHYlJ1VFFoWTFXZE1ORmR0cmJYRjRJRlVEV3p0ZHhaS1JSSXJ3eEZ4dUUwZApLZEtJV2M4cTFGSVZ6N0dLK3JHeWNHdUhwd3RxN3R1YU91czN0c0VHMG9icmhVOUZJZ2VFS1IrZ1I0aUUxaVQ2Ck9CejFMVTQyMXdhQjkrQUVJQ0ZjQ2NoOWgwd1hvb2hqSjRtaUowMTFSR3REazZnS25Nd3ovSEVDZ1lFQTBTdG8KcHZkNHAycWxUUUo0TjRlYm9Sa2hzT0pLQ3d1Z2lGMnJKbm1IdmJjM0p5QmZ3cVI5VjFzOG8zSG9EVnlmdTgxTQpUR1hSWG94a0V0bmJSUWhrN1FQRHh3OGZPNzJDVDZTN2xScEpaU2lPbEhLVStqL1lRUnhpUnpTSTUrYzNVQzdCCjlMaUFkK2ZicmU2MGRvSkd1STVleWIxVzNuR1grRTdKdVF6bTBxOENnWUVBdXhOdGxNZ2VwUldUd0JTZHpWdVYKWW5EZ0ZQdDBiSXlkUnBXRUk0TDlRYkVoYzJZQ1V4OXliSk9Zb0s5NnRoRkFHWk5zQzl0cEg1NWthaXppQlYyQQpPU043dlQ4VHF5MDNteWhUK2F2VlFSTHIycDFXVC8zWU01V3k3bUN2dE9aQklJUmZLTCswRHl1VlJmRjlvWHRyCmFRV3V5K25aMEFYSlNTYS9TSVA2cm5FQ2dZQkVNNncrN09ncFpvdVpqWm1YT1o5VUt2YWlUMWFuUFZaTndJVUMKMlpPYUYzaGpTSm9ReEVPZVRVQjdack9zVDZ4QnR4SU93eEEralBaQWMwcWN1cnoxejBseHlZdDhsakU4T05GMQpMNG9JOHUxeWw5M2RyeDJiTlY4U0twNE5SNFh3bmg1ZDVoNzFlZU5XVmtQL2RFRU5BbGNEM3JuSmRDNkNKMlo4CjhTaitQd0tCZ0NQalpscWlaOXNaWHNNTWxJbzZDMUpac2lHUFVlWE9xTEhNejdLbm1IMFRuTm9TQzEycGlpcHAKbEFXWjNiSTZlTkQxVWVIbDdmZ1JIZk1zaC8vWFc0VDV4MjVrZFVuRDRhdk9OTjRFbkdJNktZYVUvSmNiYkZ0UApuSDhlWVRUeHZaYWZBTGNVQTA3Q1NFR0h5ZUp5STUzb3QvVjM3UmNjU3pLaWNuTzgwUytVCi0tLS0tRU5EIFJTQSBQUklWQVRFIEtFWS0tLS0tCg=="
   SLEEVE_OAUTH_CLIENT_ID: "49bc7245-2c2f-4677-a4ba-93c74a27189f"
   SLEEVE_OAUTH_CLIENT_SECRET: "63678329-bda4-487f-802d-c312f6fad9df"

Description of Fields

Dock Initialization Fields

Field Description
Name The display name for this Dock.
Users List of users that will have access to this Dock.
Groups List of groups that will have access to this Dock.