From a7b420d69baf411ba7bdf705e874209a5e3291eb Mon Sep 17 00:00:00 2001 From: Ramon Smits Date: Mon, 16 Dec 2024 10:14:20 +0100 Subject: [PATCH 1/9] wip --- menu/menu.yaml | 2 + servicecontrol/hosting.md | 60 +++++++++++++++++++ .../servicecontrol-instances/hardware.md | 4 -- 3 files changed, 62 insertions(+), 4 deletions(-) create mode 100644 servicecontrol/hosting.md diff --git a/menu/menu.yaml b/menu/menu.yaml index aa37e3329ee..e820c8f2c0a 100644 --- a/menu/menu.yaml +++ b/menu/menu.yaml @@ -1439,6 +1439,8 @@ Url: servicecontrol/how - Title: Licensing Url: servicecontrol/license + - Title: Hosting + Url: servicecontrol/hosting - Title: Support policy Url: servicecontrol/upgrades/support-policy - Title: Supported versions diff --git a/servicecontrol/hosting.md b/servicecontrol/hosting.md new file mode 100644 index 00000000000..2e2733429b9 --- /dev/null +++ b/servicecontrol/hosting.md @@ -0,0 +1,60 @@ + +ServiceControl instances can be hosted on: + +- Windows Server (virtual machines) +- Linux containers + + +Deployment options: + +- [Monitoring instances](/servicecontrol/monitoring-instances/deployment/) +- [Audit instances](/servicecontrol/audit-instances/deployment/) +- [Error instances](/servicecontrol/servicecontrol-instances/deployment/) + +## Windows Server + +Instances can be installed on Windows Server (virtual) machines using: + +- Management UI: ServiceControl Management Utility +- Commandline: ServiceControl Powershell Module + +### Supported editions + +- Datacenter +- Standard + +### Supported versions + +The supported Windows Server versions are aligned with the [Microsoft Mainstream support end date for Windows Server](https://learn.microsoft.com/en-us/windows-server/get-started/windows-server-release-info). + +## Containers + +Various containerized hosting options are available: + +- Docker +- Kubernetes + +### Supported architectures + +- `linux/arm64` +- `linux/amd64` + +### Supported environments + +The following environments are getting production supports + +- Azure Container Apps +- Azure Managed Kubernetes Service (AKS) +- Amazon Elastic Kubernetes Service +- Docker Engine on Windows 2022 + +### Known working environments + +Docker and Kubernetes are available in many configurations and environments. Many will "just work" but are unsupported for production deployments. + +The following additional environments are known to work: + +- Docker Desktop for Windows +- Docker on Mac +- Docker on Fedora +- Podman on Fedora Workstation 41 diff --git a/servicecontrol/servicecontrol-instances/hardware.md b/servicecontrol/servicecontrol-instances/hardware.md index 4d846143640..58f23d9a533 100644 --- a/servicecontrol/servicecontrol-instances/hardware.md +++ b/servicecontrol/servicecontrol-instances/hardware.md @@ -39,10 +39,6 @@ Disk, CPU, RAM, and network performance may be monitored using the Windows Resou > [!NOTE] > Do not use an ephemeral AWS or Azure disk for ServiceControl data because these disks will be erased when the virtual machine reboots. -### Hosting in the cloud - -At this time, the only way to host ServiceControl in the cloud is to use a virtual machine. - ## Improving performance ### Increase RAM From fe42d73137661ca7181f7e33af686155e14a5156 Mon Sep 17 00:00:00 2001 From: Dennis van der Stelt Date: Mon, 16 Dec 2024 10:36:28 +0100 Subject: [PATCH 2/9] Added header --- servicecontrol/hosting.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/servicecontrol/hosting.md b/servicecontrol/hosting.md index 2e2733429b9..964f74a58ff 100644 --- a/servicecontrol/hosting.md +++ b/servicecontrol/hosting.md @@ -1,3 +1,9 @@ +--- +title: ServiceControl Hosting Options +summary: Hosting options for running ServiceControl instances +component: ServiceControl +reviewed: 2024-12-16 +--- ServiceControl instances can be hosted on: From 64e8520fcd250423b28b412a7a42b40bd3a6b6a4 Mon Sep 17 00:00:00 2001 From: Ramon Smits Date: Mon, 16 Dec 2024 10:45:02 +0100 Subject: [PATCH 3/9] Docker Desktop for Mac --- servicecontrol/hosting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/servicecontrol/hosting.md b/servicecontrol/hosting.md index 964f74a58ff..6dc22f78f07 100644 --- a/servicecontrol/hosting.md +++ b/servicecontrol/hosting.md @@ -61,6 +61,6 @@ Docker and Kubernetes are available in many configurations and environments. Man The following additional environments are known to work: - Docker Desktop for Windows -- Docker on Mac +- Docker Desktop for Mac - Docker on Fedora - Podman on Fedora Workstation 41 From 6fb60e03ce31941137ee68f47efb0cd5d96dcf3f Mon Sep 17 00:00:00 2001 From: Ramon Smits Date: Mon, 16 Dec 2024 14:44:51 +0100 Subject: [PATCH 4/9] ECS --- servicecontrol/hosting.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/servicecontrol/hosting.md b/servicecontrol/hosting.md index 6dc22f78f07..ce7c64edf6b 100644 --- a/servicecontrol/hosting.md +++ b/servicecontrol/hosting.md @@ -51,9 +51,11 @@ The following environments are getting production supports - Azure Container Apps - Azure Managed Kubernetes Service (AKS) -- Amazon Elastic Kubernetes Service +- Amazon Elastic Kubernetes Service (EKS) +- Amazon Elastic Container Service (ECS) - Docker Engine on Windows 2022 + ### Known working environments Docker and Kubernetes are available in many configurations and environments. Many will "just work" but are unsupported for production deployments. From 588b99c432a7b0c2f04f49bfddd494316e300dca Mon Sep 17 00:00:00 2001 From: Ramon Smits Date: Mon, 20 Jan 2025 17:33:22 +0100 Subject: [PATCH 5/9] Change order --- servicecontrol/hosting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/servicecontrol/hosting.md b/servicecontrol/hosting.md index ce7c64edf6b..9c14799ab38 100644 --- a/servicecontrol/hosting.md +++ b/servicecontrol/hosting.md @@ -21,8 +21,8 @@ Deployment options: Instances can be installed on Windows Server (virtual) machines using: -- Management UI: ServiceControl Management Utility - Commandline: ServiceControl Powershell Module +- Management UI: ServiceControl Management Utility ### Supported editions From 569a5b4cda4dfcc13d374dca6efef909392977d8 Mon Sep 17 00:00:00 2001 From: Ramon Smits Date: Mon, 20 Jan 2025 17:39:58 +0100 Subject: [PATCH 6/9] Feedback --- servicecontrol/hosting.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/servicecontrol/hosting.md b/servicecontrol/hosting.md index 9c14799ab38..03dd31c764f 100644 --- a/servicecontrol/hosting.md +++ b/servicecontrol/hosting.md @@ -2,7 +2,7 @@ title: ServiceControl Hosting Options summary: Hosting options for running ServiceControl instances component: ServiceControl -reviewed: 2024-12-16 +reviewed: 2025-01-20 --- ServiceControl instances can be hosted on: @@ -35,7 +35,7 @@ The supported Windows Server versions are aligned with the [Microsoft Mainstream ## Containers -Various containerized hosting options are available: +That Particular Platform images are OCI compliant and can be used in various environments: - Docker - Kubernetes @@ -47,7 +47,7 @@ Various containerized hosting options are available: ### Supported environments -The following environments are getting production supports +The following environments are supported: - Azure Container Apps - Azure Managed Kubernetes Service (AKS) @@ -55,7 +55,6 @@ The following environments are getting production supports - Amazon Elastic Container Service (ECS) - Docker Engine on Windows 2022 - ### Known working environments Docker and Kubernetes are available in many configurations and environments. Many will "just work" but are unsupported for production deployments. From 6d790c8e84465aecdb222f37fb61cfc68706d74e Mon Sep 17 00:00:00 2001 From: Ramon Smits Date: Thu, 20 Mar 2025 13:05:19 +0000 Subject: [PATCH 7/9] Removed supported vs working sections --- servicecontrol/hosting.md | 24 ++---------------------- 1 file changed, 2 insertions(+), 22 deletions(-) diff --git a/servicecontrol/hosting.md b/servicecontrol/hosting.md index 03dd31c764f..72f6f4de17c 100644 --- a/servicecontrol/hosting.md +++ b/servicecontrol/hosting.md @@ -2,7 +2,7 @@ title: ServiceControl Hosting Options summary: Hosting options for running ServiceControl instances component: ServiceControl -reviewed: 2025-01-20 +reviewed: 2025-03-20 --- ServiceControl instances can be hosted on: @@ -39,29 +39,9 @@ That Particular Platform images are OCI compliant and can be used in various env - Docker - Kubernetes +- Podman ### Supported architectures - `linux/arm64` - `linux/amd64` - -### Supported environments - -The following environments are supported: - -- Azure Container Apps -- Azure Managed Kubernetes Service (AKS) -- Amazon Elastic Kubernetes Service (EKS) -- Amazon Elastic Container Service (ECS) -- Docker Engine on Windows 2022 - -### Known working environments - -Docker and Kubernetes are available in many configurations and environments. Many will "just work" but are unsupported for production deployments. - -The following additional environments are known to work: - -- Docker Desktop for Windows -- Docker Desktop for Mac -- Docker on Fedora -- Podman on Fedora Workstation 41 From f80a7a58d95018abddb39354a2fa39c6b3ac9d74 Mon Sep 17 00:00:00 2001 From: Mauro Servienti Date: Fri, 28 Mar 2025 06:21:45 +0100 Subject: [PATCH 8/9] Update servicecontrol/hosting.md --- servicecontrol/hosting.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/servicecontrol/hosting.md b/servicecontrol/hosting.md index 72f6f4de17c..a9fcad6d53b 100644 --- a/servicecontrol/hosting.md +++ b/servicecontrol/hosting.md @@ -9,8 +9,6 @@ ServiceControl instances can be hosted on: - Windows Server (virtual machines) - Linux containers - - Deployment options: - [Monitoring instances](/servicecontrol/monitoring-instances/deployment/) From 13b859d452be6cbfa1952137c4a3648aba74bb70 Mon Sep 17 00:00:00 2001 From: Ramon Smits Date: Wed, 16 Apr 2025 10:08:24 +0200 Subject: [PATCH 9/9] Converted message on disk limitationt to a warning section --- servicecontrol/servicecontrol-instances/hardware.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/servicecontrol/servicecontrol-instances/hardware.md b/servicecontrol/servicecontrol-instances/hardware.md index 58f23d9a533..9ca5742182c 100644 --- a/servicecontrol/servicecontrol-instances/hardware.md +++ b/servicecontrol/servicecontrol-instances/hardware.md @@ -39,6 +39,16 @@ Disk, CPU, RAM, and network performance may be monitored using the Windows Resou > [!NOTE] > Do not use an ephemeral AWS or Azure disk for ServiceControl data because these disks will be erased when the virtual machine reboots. +### Hosting in the cloud + +ServiceControl can be hosted in the cloud by: + +- Using a virtual machine +- Using a container hosting service. + +> [!WARNING] +> Due to [RavenDB networked disk limitations](https://ravendb.net/docs/article-page/6.0/csharp/start/installation/running-in-docker-container#requirements) there may be [difficulties running the RavenDB container in the cloud with PaaS services](https://github.com/Particular/ServiceControl/issues/3340#issuecomment-2313694640) like [Azure Container Instances](https://azure.microsoft.com/en-us/products/container-instances) or [AWS Elastic Container Service](https://aws.amazon.com/ecs/). ServiceControl containers are compatible with [RavenDB Cloud](https://ravendb.net/cloud). + ## Improving performance ### Increase RAM