From 74423afcf29554fb3c83c74a99678c1f129e70b7 Mon Sep 17 00:00:00 2001 From: clemensv Date: Wed, 21 Sep 2022 04:59:49 -0700 Subject: [PATCH] doc updates Signed-off-by: clemensv --- OVERVIEW.md | 53 +++++++++++++++++++++++++++++++++++++++++++---------- README.md | 2 ++ 2 files changed, 45 insertions(+), 10 deletions(-) diff --git a/OVERVIEW.md b/OVERVIEW.md index a95a145..c7ab522 100644 --- a/OVERVIEW.md +++ b/OVERVIEW.md @@ -109,10 +109,42 @@ constellation: The `{cxnstring}` represents the connection string for the configured Azure Relay endpoint with appropriate send and/or listen permissions. -The connection string can be obtained from the portal. +The connection string can be obtained from the portal or Azure CLI, as +explained in the [README.md](README.md#hybrid-connection-setup). -Further details about how to use the tool and how to configure it can be found in -the [Configuration and Command Line Options](CONFIG.md) document. +Further details about how to use the tool and how to configure it can be found +in the [Configuration and Command Line Options](CONFIG.md) document. For all +settings, including the namespace connection string you can set defaults in a +machine-wide configuration file that is described in the [configuration +file](CONFIG.md#configuration-file) section of that document. + +## Services and Daemons + +When the tool is installed via MSI file on Windows or via one of the DEB or RPM +packages on Linux, the tool is also installed as a system service. + +### Windows Service + +On Windows, the service name is "azbridgesvc". The service can be started and +stopped using any service control manager tool, such as +[`sc.exe`](https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/sc-config). + +The configuration data for the Windows Service is read from the +`$env:ProgramData\Microsoft\Azure Relay Bridge\azbridge_config.svc.yml` file, +which is described in [CONFIG.md](CONFIG.md#configuration-file). + +The file requires administrative permissions to change. + +### Linux SystemD daemon + +On Linux, the service is registered with systemd as "azbridge.service" and +can be managed with `systemctl`. + +The configuration data for the daemon is read from the +`/etc/azbridge/azbridge_config.svc.yml` file, +which is described in [CONFIG.md](CONFIG.md#configuration-file). + +The file requires administrative permissions to change. ## Downloads @@ -133,17 +165,18 @@ The easiest way to install the bridge on Windows is by using the appropriate registers the "azbridge" Windows service. The service is configured for on-demand (manual) start at installation time. -> **IMPORTANT:** The builds are not signed. Download the MSI file, -[unblock it](https://winaero.com/how-to-unblock-files-downloaded-from-the-internet-in-windows-11), and then install. Otherwise the application may not work as -expected. +> **IMPORTANT:** The builds are not signed. Download the MSI file, [unblock +it](https://winaero.com/how-to-unblock-files-downloaded-from-the-internet-in-windows-11), +and then install. Otherwise the application may not work as expected. ### Docker -Download the `azbridge-oci-image-x.x.x.tar` file from the releases page and import it -into your docker image repository using `docker load -i azbridge-oci-image-x.x.x.tar`. +Download the `azbridge-oci-image-x.x.x.tar` file from the releases page and +import it into your docker image repository using `docker load -i +azbridge-oci-image-x.x.x.tar`. -The docker image's entry point is the azbridge tool itself, meaning you can run the -container with `docker run --rm -it azbridge {parameters}`. +The docker image's entry point is the azbridge tool itself, meaning you can run +the container with `docker run --rm -it azbridge {parameters}`. If you want to use the image as a base image to override the entry point, the configured entry point for the installed runtime is at `app/azbridge`. diff --git a/README.md b/README.md index e7eb3da..ff5dfc6 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,8 @@ On the database machine, the bridge is bound in the reverse, mapping "db" to the local TCP port 16161 as a client connecting to the database with the `-T` option. All traffic through the bridge is forwarded end-to-end. +## Hybrid Connection Setup + The required Azure Relay resource (the *Hybrid Connection*) can be set up with a few lines of script (showing BASH syntax):