Better ServiceControl container docs for license and external RavenDB

servicecontrol/audit-instances/deployment/containers.md

@@ -46,14 +46,11 @@ Using `--setup-and-run` removes the need to repeat a setup process when the cont
 
 ## Required settings
 
-The following environment settings are required to run a ServiceControl audit instance:
-
-| Environment Variable | Description |
-|-|-|
-| `TRANSPORTTYPE` | Determines the message transport used to communicate with message endpoints. See [ServiceControl transport configuration](/servicecontrol/transports.md) for valid TransportType values. |
-| `CONNECTIONSTRING` | Provides the connection information to connect to the chosen transport. The form of this connection string is different for every message transport. See [ServiceControl transport support](/servicecontrol/transports.md) for more details on options available to each message transport. |
-| `RAVENDB_CONNECTIONSTRING` | Provides the URL to connect to the [database container](/servicecontrol/ravendb/containers.md) that stores the audit instance's data. The database container should be exclusive to the error instance, and not shared by any other ServiceControl instances. |
-| `PARTICULARSOFTWARE_LICENSE` | The Particular Software license. The environment variable should contain the full multi-line contents of the license file. |
+The following environment settings are required to run a ServiceControl audit instance.
+
+include: servicecontrol-container-transport
+include: servicecontrol-container-ravenconnectionstring
+include: servicecontrol-container-license
 
 ## Ports
 

servicecontrol/common-includes/containers/servicecontrol-container-license.include.md

@@ -0,0 +1,11 @@
+### License
+
+_Environment variable:_ `PARTICULARSOFTWARE_LICENSE`
+
+The Particular Software license, which is most easily provided to a container [as an environment variable](/nservicebus/licensing/#license-management-environment-variable). The environment variable should contain the full multi-line contents of the license file.
+
+A license file can also be volume-mounted to the container in the [machine-wide license location for Linux](/nservicebus/licensing/#license-management-machine-wide-license-location):
+
+```shell
+-v license.xml:/usr/share/ParticularSoftware/license.xml
+```

servicecontrol/common-includes/containers/servicecontrol-container-ravenconnectionstring.include.md

@@ -0,0 +1,11 @@
+### RavenDB connection string
+
+_Environment variable:_ `RAVENDB_CONNECTIONSTRING`
+
+Provides the URL to connect to the database container that stores the audit instance's data. The database container should be exclusive to the error instance, and not shared by any other ServiceControl instances.
+
+If the [storage requirements for the RavenDB container](/servicecontrol/ravendb/containers.md#required-settings) cannot be met by the container hosting infrastructure, especially in cloud-hosted environments, an externally-hosted and separately-licensed RavenDB instance can also be used starting with ServiceControl version 6.0.
+
+In this case, the RavenDB Major.Minor version must match the version expected by ServiceControl as shown in this table:
+
+include: servicecontrol-ravendb-versions

servicecontrol/common-includes/containers/servicecontrol-container-transport.include.md

@@ -0,0 +1,12 @@
+### Transport type
+
+_Environment variable:_ `TRANSPORTTYPE`
+
+ Determines the message transport used to communicate with message endpoints. See [ServiceControl transport configuration](/servicecontrol/transports.md) for valid TransportType values.
+
+ ### Transport connection string
+
+_Environment variable:_ `CONNECTIONSTRING`
+
+Provides the connection information to connect to the chosen transport. The form of this connection string is different for every message transport. See [ServiceControl transport support](/servicecontrol/transports.md) for more details on options available to each message transport.
+

servicecontrol/common-includes/containers/servicecontrol-ravendb-versions.include.md

@@ -0,0 +1,5 @@
+<!-- This include file may be auto-generated in the future -->
+
+| ServiceControl Versions | RavenDB Version |
+|:-:|:-:|
+| `6.*` | `6.2` |

servicecontrol/monitoring-instances/deployment/containers.md

@@ -47,11 +47,8 @@ Using `--setup-and-run` removes the need to repeat a setup process when the cont
 
 The following environment settings are required to run a ServiceControl monitoring instance:
 
-| Environment Variable | Description |
-|-|-|
-| `TRANSPORTTYPE` | Determines the message transport used to communicate with message endpoints. See [ServiceControl transport configuration](/servicecontrol/transports.md) for valid TransportType values. |
-| `CONNECTIONSTRING` | Provides the connection information to connect to the chosen transport. The form of this connection string is different for every message transport. See [ServiceControl transport support](/servicecontrol/transports.md) for more details on options available to each message transport. |
-| `PARTICULARSOFTWARE_LICENSE` | The Particular Software license. The environment variable should contain the full multi-line contents of the license file. |
+include: servicecontrol-container-transport
+include: servicecontrol-container-license
 
 ## Ports
 

servicecontrol/servicecontrol-instances/deployment/containers.md

@@ -48,15 +48,18 @@ Using `--setup-and-run` removes the need to repeat a setup process when the cont
 
 ## Required settings
 
-The following environment settings are required to run a ServiceControl error instance:
-
-| Environment Variable | Description |
-|-|-|
-| `TRANSPORTTYPE` | Determines the message transport used to communicate with message endpoints. See [ServiceControl transport configuration](/servicecontrol/transports.md) for valid TransportType values. |
-| `CONNECTIONSTRING` | Provides the connection information to connect to the chosen transport. The form of this connection string is different for every message transport. See [ServiceControl transport support](/servicecontrol/transports.md) for more details on options available to each message transport. |
-| `RAVENDB_CONNECTIONSTRING` | Provides the URL to connect to the [database container](/servicecontrol/ravendb/containers.md) that stores the error instance's data. The database container should be exclusive to the error instance, and not shared by any other ServiceControl instances. |
-| `REMOTEINSTANCES` | A JSON structure that provides URLs for the Error instance to access any [remote audit instances](/servicecontrol/servicecontrol-instances/remotes.md). When requesting audit data via the ServiceControl API, the Error instance will communicate to each of the remote audit instances in a scatter-gather pattern and then return the combined results. The URLs must be accessible by the Error instance directly, not constructed to be accessible from an external browser. |
-| `PARTICULARSOFTWARE_LICENSE` | The Particular Software license. The environment variable should contain the full multi-line contents of the license file. |
+_Environment variable:_ `REMOTEINSTANCES`
+
+The following environment settings are required to run a ServiceControl error instance.
+
+include: servicecontrol-container-transport
+include: servicecontrol-container-ravenconnectionstring
+
+### Remote instances
+
+A JSON structure that provides URLs for the Error instance to access any [remote audit instances](/servicecontrol/servicecontrol-instances/remotes.md). When requesting audit data via the ServiceControl API, the Error instance will communicate to each of the remote audit instances in a scatter-gather pattern and then return the combined results. The URLs must be accessible by the Error instance directly, not constructed to be accessible from an external browser.
+
+include: servicecontrol-container-license
 
 ## Ports