From b47fb44ef818506cf7805113a9b6bf1f9dded29a Mon Sep 17 00:00:00 2001 From: Roman Marusyk Date: Fri, 22 Nov 2024 11:46:41 +0200 Subject: [PATCH] Switch to [MSSQL](https://hub.docker.com/r/microsoft/mssql-server) for development/testing as [Azure SQL Edge will be retired on September 30th, 2025](https://azure.microsoft.com/nb-no/updates/v2/azure-sql-edge-retirement) --- .../docker-compose-default.yml | 16 ++++---- .../docker-compose-with-containerized-app.yml | 14 +++---- README.md | 37 +++++++------------ .../Scripts/Linux/LaunchEmulator.sh | 2 +- .../Scripts/Mac/LaunchEmulator.sh | 2 +- .../Scripts/Windows/LaunchEmulator.ps1 | 2 +- 6 files changed, 31 insertions(+), 42 deletions(-) diff --git a/Docker-Compose-Template/docker-compose-default.yml b/Docker-Compose-Template/docker-compose-default.yml index 6181172..b71fb51 100644 --- a/Docker-Compose-Template/docker-compose-default.yml +++ b/Docker-Compose-Template/docker-compose-default.yml @@ -8,25 +8,25 @@ services: ports: - "5672:5672" environment: - SQL_SERVER: sqledge - MSSQL_SA_PASSWORD: "${SQL_PASSWORD}" # Password should be same as what is set for SQL Edge + SQL_SERVER: sqlserver + MSSQL_SA_PASSWORD: "${SQL_PASSWORD}" # Password should be same as what is set for SQL Server ACCEPT_EULA: ${ACCEPT_EULA} depends_on: - - sqledge + - sqlserver networks: sb-emulator: aliases: - "sb-emulator" - sqledge: - container_name: "sqledge" - image: "mcr.microsoft.com/azure-sql-edge:latest" + sqlserver: + container_name: "sqlserver" + image: "mcr.microsoft.com/mssql/server:latest" networks: sb-emulator: aliases: - - "sqledge" + - "sqlserver" environment: ACCEPT_EULA: ${ACCEPT_EULA} - MSSQL_SA_PASSWORD: "${SQL_PASSWORD}" # To be filled by user as per policy : https://learn.microsoft.com/en-us/sql/relational-databases/security/strong-passwords?view=sql-server-linux-ver16 + MSSQL_SA_PASSWORD: "${SQL_PASSWORD}" # To be filled by user as per policy : https://learn.microsoft.com/en-us/sql/relational-databases/security/strong-passwords?view=sql-server-linux-ver16 networks: sb-emulator: diff --git a/Docker-Compose-Template/docker-compose-with-containerized-app.yml b/Docker-Compose-Template/docker-compose-with-containerized-app.yml index ca5e760..b1f521b 100644 --- a/Docker-Compose-Template/docker-compose-with-containerized-app.yml +++ b/Docker-Compose-Template/docker-compose-with-containerized-app.yml @@ -7,15 +7,15 @@ services: - "./Config.json:/ServiceBus-Emulator/ConfigFiles/Config.json" ports: - "5672:5672" - environment: - SQL_SERVER: sqledge - MSSQL_SA_PASSWORD: "" # Password should be same as what is set for SQL Edge + environment: + SQL_SERVER: sqlserver + MSSQL_SA_PASSWORD: "" # Password should be same as what is set for SQL Server ACCEPT_EULA: "N" depends_on: - - sqledge - sqledge: - container_name: "sqledge" - image: "mcr.microsoft.com/azure-sql-edge:latest" + - sqlserver + sqlserver: + container_name: "sqlserver" + image: "mcr.microsoft.com/mssql/server:latest" environment: ACCEPT_EULA: "N" MSSQL_SA_PASSWORD: "" # To be filled by user as per policy : https://learn.microsoft.com/en-us/sql/relational-databases/security/strong-passwords?view=sql-server-linux-ver16 diff --git a/README.md b/README.md index d0d7e2d..a84fdfc 100644 --- a/README.md +++ b/README.md @@ -17,21 +17,21 @@ This repository contains the scripts required to install and run the [Azure Ser Azure Service Bus is a fully managed enterprise message broker offering queues and publish-subscribe topics. It decouples applications and services, providing benefits like load-balancing across workers, safe data and control routing, and reliable transactional coordination. Read more [here](https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-messaging-overview). -## About Azure Service Bus emulator +## About Azure Service Bus emulator The Azure Service Bus emulator offers a local development experience for the Service bus service. You can use the emulator to develop and test code against the service in isolation, free from cloud interference. >[!CAUTION] >Emulator is intended solely for development and testing scenarios.Any kind of Production use is strictly discouraged. There is no official support provided for Emulator. > Any issues/suggestions should be reported via GitHub issues on [GitHub project](https://github.com/Azure/azure-service-bus-emulator-installer/issues). -## Run Azure Service Bus Emulator +## Run Azure Service Bus Emulator This section summarizes the steps to develop and test locally with Service Bus Emulator. To read more about Service Bus, read [here](https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-messaging-overview). ## Prerequisites -- Docker - - [Docker Desktop](https://docs.docker.com/desktop/install/windows-install/#:~:text=Install%20Docker%20Desktop%20on%20Windows%201%20Download%20the,on%20your%20choice%20of%20backend.%20...%20More%20items) +- Docker + - [Docker Desktop](https://docs.docker.com/desktop/install/windows-install/#:~:text=Install%20Docker%20Desktop%20on%20Windows%201%20Download%20the,on%20your%20choice%20of%20backend.%20...%20More%20items) - Minimum hardware Requirements: - 2 GB RAM - 5 GB of Disk space @@ -42,29 +42,29 @@ This section summarizes the steps to develop and test locally with Service Bus E >[!NOTE] >Before you continue with the subsequent steps, make sure Docker Engine is operational in the background. -## Running the Emulator +## Running the Emulator This section highlights different steps to run Service Bus Emulator. Details are as follows: #### [Using Automated Script](#tab/automated-script) Before running automated script, clone the installation [repository](https://github.com/Azure/azure-service-bus-emulator-installer) locally. - + ### Windows -After completing the prerequisites, you can proceed with the following steps to run the Service Bus Emulator locally. +After completing the prerequisites, you can proceed with the following steps to run the Service Bus Emulator locally. 1. Before executing the setup script, we need to allow execution of unsigned scripts. Run the below command in the PowerShell window: `$>Start-Process powershell -Verb RunAs -ArgumentList 'Set-ExecutionPolicy Bypass –Scope CurrentUser’` -2. Execute setup script `LaunchEmulator.ps1`. Running the script would bring up two containers – Service Bus Emulator & Azure SQL Edge (dependency for Emulator) +2. Execute setup script `LaunchEmulator.ps1`. Running the script would bring up two containers – Service Bus Emulator & SQL Server (dependency for Emulator) ### Linux & macOS -After completing the prerequisites, you can proceed with the following steps to run the Service Bus Emulator locally. +After completing the prerequisites, you can proceed with the following steps to run the Service Bus Emulator locally. -1. Execute the setup script `LaunchEmulator.sh` . Running the script would bring up two containers – Service Bus Emulator & Azure SQL Edge (dependency for Emulator) +1. Execute the setup script `LaunchEmulator.sh` . Running the script would bring up two containers – Service Bus Emulator & SQL Server (dependency for Emulator) 2. Execute the same script `LaunchEmulator.sh` with the option `--compose-down=Y` to issue a `docker compose down` to terminate the containers. @@ -89,7 +89,7 @@ Once the steps are successful, Emulator compose set can be found running in Dock ## Interact with the emulator -By default, emulator uses [config.json](https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/ServiceBus-Emulator/Config/Config.json) configuration file. You can configure entities by making changes to configuration file. To know more, visit [make configuration changes](https://learn.microsoft.com/en-us/azure/service-bus-messaging/overview-emulator#quota-configuration-changes). +By default, emulator uses [config.json](https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/ServiceBus-Emulator/Config/Config.json) configuration file. You can configure entities by making changes to configuration file. To know more, visit [make configuration changes](https://learn.microsoft.com/en-us/azure/service-bus-messaging/overview-emulator#quota-configuration-changes). >[!NOTE] > Service Bus emulator isn't compatible with the community owned [open source Service Bus Explorer](https://github.com/paolosalvatori/ServiceBusExplorer) @@ -125,17 +125,6 @@ There is no official support provided for Emulator.Any issues/suggestions should The scripts and documentation in this project are released under the MIT License. -The software (Azure Service Bus Emulator and Sql Edge) that the scripts in this repository install are licensed under separate terms. Refer to the terms governing each software below: +The software (Azure Service Bus Emulator and SQL Server) that the scripts in this repository install are licensed under separate terms. Refer to the terms governing each software below: - Azure Service Bus emulator : [EULA](https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/EMULATOR_EULA.txt) -- Azure SQL Edge Developer Edition: [EULA](https://go.microsoft.com/fwlink/?linkid=2139274) - - SQL Edge provides Developer and Premium editions, Service Bus Emulator relies on the Developer edition which is licensed for use as a development and test system and cannot be used in a production environment. - - - - - - - - - - +- SQL Server: [EULA](https://go.microsoft.com/fwlink/?linkid=857698) diff --git a/ServiceBus-Emulator/Scripts/Linux/LaunchEmulator.sh b/ServiceBus-Emulator/Scripts/Linux/LaunchEmulator.sh index 70a44a0..b11de07 100755 --- a/ServiceBus-Emulator/Scripts/Linux/LaunchEmulator.sh +++ b/ServiceBus-Emulator/Scripts/Linux/LaunchEmulator.sh @@ -83,7 +83,7 @@ if [[ "$COMPOSE_DOWN" != 'y' && "$COMPOSE_DOWN" != 'Y' ]]; then # Check if ACCEPT_EULA is 'Y' or 'y' if [[ "$ACCEPT_EULA" != "y" && "$ACCEPT_EULA" != "Y" ]]; then # EULA - echo 'By pressing "Y", you are expressing your consent to the End User License Agreement (EULA) for Service-Bus Emulator: https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/EMULATOR_EULA.txt and Azure SQL Edge : https://go.microsoft.com/fwlink/?linkid=2139274' + echo 'By pressing "Y", you are expressing your consent to the End User License Agreement (EULA) for Service-Bus Emulator: https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/EMULATOR_EULA.txt and SQL Server : https://go.microsoft.com/fwlink/?linkid=857698' read ACCEPT_EULA if [[ "$ACCEPT_EULA" != "y" && "$ACCEPT_EULA" != "Y" ]]; then echo "You must accept the EULA (Press 'Y') to continue. Exiting script." diff --git a/ServiceBus-Emulator/Scripts/Mac/LaunchEmulator.sh b/ServiceBus-Emulator/Scripts/Mac/LaunchEmulator.sh index 70a44a0..b11de07 100755 --- a/ServiceBus-Emulator/Scripts/Mac/LaunchEmulator.sh +++ b/ServiceBus-Emulator/Scripts/Mac/LaunchEmulator.sh @@ -83,7 +83,7 @@ if [[ "$COMPOSE_DOWN" != 'y' && "$COMPOSE_DOWN" != 'Y' ]]; then # Check if ACCEPT_EULA is 'Y' or 'y' if [[ "$ACCEPT_EULA" != "y" && "$ACCEPT_EULA" != "Y" ]]; then # EULA - echo 'By pressing "Y", you are expressing your consent to the End User License Agreement (EULA) for Service-Bus Emulator: https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/EMULATOR_EULA.txt and Azure SQL Edge : https://go.microsoft.com/fwlink/?linkid=2139274' + echo 'By pressing "Y", you are expressing your consent to the End User License Agreement (EULA) for Service-Bus Emulator: https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/EMULATOR_EULA.txt and SQL Server : https://go.microsoft.com/fwlink/?linkid=857698' read ACCEPT_EULA if [[ "$ACCEPT_EULA" != "y" && "$ACCEPT_EULA" != "Y" ]]; then echo "You must accept the EULA (Press 'Y') to continue. Exiting script." diff --git a/ServiceBus-Emulator/Scripts/Windows/LaunchEmulator.ps1 b/ServiceBus-Emulator/Scripts/Windows/LaunchEmulator.ps1 index 4d33393..8d9f294 100644 --- a/ServiceBus-Emulator/Scripts/Windows/LaunchEmulator.ps1 +++ b/ServiceBus-Emulator/Scripts/Windows/LaunchEmulator.ps1 @@ -16,7 +16,7 @@ if ($PSBoundParameters.ContainsKey('ACCEPT_EULA')) { } else{ # EULA - $ACCEPT_EULA = Read-Host 'By pressing "Y", you are expressing your consent to the End User License Agreement (EULA) for Service-Bus Emulator: https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/EMULATOR_EULA.txt and Azure SQL Edge : https://go.microsoft.com/fwlink/?linkid=2139274' + $ACCEPT_EULA = Read-Host 'By pressing "Y", you are expressing your consent to the End User License Agreement (EULA) for Service-Bus Emulator: https://github.com/Azure/azure-service-bus-emulator-installer/blob/main/EMULATOR_EULA.txt and SQL Server : https://go.microsoft.com/fwlink/?linkid=857698' if ($ACCEPT_EULA -ne 'y' -and $ACCEPT_EULA -ne 'Y') { Write-Host "You must accept the EULA (Press 'Y') to continue. Exiting script." exit