diff --git a/content/documentation/archive/installing/docker-compose.md b/content/documentation/archive/installing/docker-compose.md deleted file mode 100644 index 12e6cc57..00000000 --- a/content/documentation/archive/installing/docker-compose.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -draft: false -title: "Using docker-compose" -date: 2019-09-01 -publishdate: 2019-09-01 -lastmod: 2023-06-21 -weight: 3 ---- - -[Docker Compose](https://docs.docker.com/compose/) is a tool for easily testing and running multi-container applications. [Microcks](https://microcks.io/) offers a simple way to set up the minimal required containers to have a functional environment on your local computer. - -## Usage - -To get started, make sure you have [Docker installed](https://docs.docker.com/get-docker/) on your system. - -In your terminal issue the following commands: - -1. Clone this repository. - - ```sh - git clone https://github.com/microcks/microcks.git --depth 10 - ``` - -2. Change to the install folder - - ```sh - cd microcks/install/docker-compose - ``` - -3. Spin up the containers - - ```sh - docker compose up -d - ``` - -This will start the required containers and setup a simple environment for you to use. - -Open a new browser tab and point to the `http://localhost:8080` endpoint. This will redirect you to the [Keycloak](https://www.keycloak.org/) Single Sign On page for login. Use the following default credentials to login into the application: - -* **Username:** `admin` -* **Password:** `microcks123` - -You will be redirected to the main dashboard page. You can now start [using Microcks](https://microcks.io/documentation/getting-started/#using-microcks)! - - -### Enabling Asynchronous API features - -Support for Asynchronous API features of Microcks are not enabled by default into the `docker-compose.yml` file. If you feel your local machine has enough resources to afford it, you can enable them using a slightly different command line. - -In your terminal use the following command instead: - - ```sh - docker compose -f docker-compose.yml -f docker-compose-async-addon.yml up -d - ``` - -Docker compose is now launching additional containers, namely `zookeeper`, `kafka` and the `microcks-async-minion`. The above command should produce the following output: - -```sh -Creating network "docker-compose_default" with the default driver -Creating microcks-zookeeper ... done -Creating microcks-db ... done -Creating microcks-sso ... done -Creating microcks-postman-runtime ... done -Creating microcks ... done -Creating microcks-kafka ... done -Creating microcks-async-minion ... done -``` - -You may want to check our [blog post](../../../blog/async-features-with-docker-compose) for a detailed walkthrough on starting Async features on docker-compose. - -If you're feeling lucky regarding your machine, you can even add the [Kafdrop](https://github.com/obsidiandynamics/kafdrop) utility to visualize and troubleshoot Kafka messages with this command: - - ```sh - docker compose -f docker-compose.yml -f docker-compose-async-addon.yml -f kafdrop-addon.yml up -d - ``` - -### Un-authenticated mode - -A "keycloakless" version of docker compose is available thanks to: - - ```sh - docker compose -f docker-compose-devmode.yml up -d - ``` - -This configuration enabled Asynchronous API features in a very lightweight mode using [Red Panda broker](https://redpanda.com/) instead of full-blown Apache Kafka distribution. diff --git a/content/documentation/archive/installing/docker-desktop-extension.md b/content/documentation/archive/installing/docker-desktop-extension.md deleted file mode 100644 index 644450a9..00000000 --- a/content/documentation/archive/installing/docker-desktop-extension.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -draft: false -title: "As Docker Desktop Extension" -date: 2022-11-22 -publishdate: 2022-11-22 -lastmod: 2022-11-22 -weight: 4 ---- - -[Docker Desktop](https://docs.docker.com/desktop/) is a simple-to-install application for [Mac](https://www.docker.com/products/docker-desktop/), [Windows](https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe), or [Linux](https://docs.docker.com/desktop/linux/install/) that allows you to create and share containerized applications and microservices. Docker Desktop includes the Docker Engine, the Docker CLI client, Docker Compose, Docker Content Trust, Kubernetes, and the Credential Helper. - -## Usage - -To get started, make sure you have [Docker Desktop installed](https://docs.docker.com/desktop/#download-and-install) on your system. - -1. Select Extensions - -2. Choose Microcks, install and launch it and you are ready to go 🤩 - -> The video just below illustrates the installation process as well as the creation of a first [Direct API](../../using/dynamic/). It has never been simpler to set up and use Microcks on a laptop. 🙌 - -{{< youtube id="E8rjUwznO-Q" autoplay="false" >}} - -### Settings - -The settings panel allows you to configure some options like whether you'd like to enable the Asynchronous APIs features (default is disabled) and if you'd need to set an offset to ports that are used to access the services. - -{{< image src="images/docker-desktop-extension-settings.png" alt="image" zoomable="true" >}} - -Pretty straight forward! \ No newline at end of file diff --git a/content/documentation/guides/installation/docker-compose.md b/content/documentation/guides/installation/docker-compose.md index f790d349..9122e131 100644 --- a/content/documentation/guides/installation/docker-compose.md +++ b/content/documentation/guides/installation/docker-compose.md @@ -3,13 +3,90 @@ draft: false title: "With Docker Compose" date: 2024-04-30 publishdate: 2024-04-30 -lastmod: 2024-04-30 +lastmod: 2024-05-24 weight: 2 --- -> ♻️ **To Be Migrated** -> -> This is a documentation page that has to be migrated from [Using docker-compose](../../../archive/installation/docker-compose), as part of our [Refactoring Effort](https://github.com/microcks/microcks.io/issues/81). -> -> **Goal of this page** -> * ... \ No newline at end of file +This guide shows you how to install and run Microcks using Docker Compose. + +[Docker Compose](https://docs.docker.com/compose/) is a tool for easily testing and running multi-container applications. [Microcks](https://microcks.io/) offers a simple way to set up the minimal required containers to have a functional environment on your local computer. + +## Usage + +To get started, make sure you have [Docker installed](https://docs.docker.com/get-docker/) on your system. + +In your terminal issue the following commands: + +1. Clone this repository. + +```sh +git clone https://github.com/microcks/microcks.git --depth 10 +``` + +2. Change to the install folder + +```sh +cd microcks/install/docker-compose +``` + +3. Spin up the containers + +```sh +docker compose up -d +``` + +This will start the required containers and setup a simple environment for you to use. + +Open a new browser tab and point to the `http://localhost:8080` endpoint. This will redirect you to the [Keycloak](https://www.keycloak.org/) sign-in page for login. Use the following default credentials to login into the application: + +* **Username:** `admin` +* **Password:** `microcks123` + +You will be redirected to the main dashboard page. + +## Enabling Asynchronous API features + +Support for Asynchronous API features of Microcks are not enabled by default into the `docker-compose.yml` file. If you feel your local machine has enough resources to afford it, you can enable them using a slightly different command line. + +In your terminal use the following command instead: + +```sh +docker compose -f docker-compose.yml -f docker-compose-async-addon.yml up -d +``` + +Docker compose is now launching additional containers, namely `zookeeper`, `kafka` and the `microcks-async-minion`. The above command should produce the following output: + +```sh +Creating network "docker-compose_default" with the default driver +Creating microcks-zookeeper ... done +Creating microcks-db ... done +Creating microcks-sso ... done +Creating microcks-postman-runtime ... done +Creating microcks ... done +Creating microcks-kafka ... done +Creating microcks-async-minion ... done +``` + +You may want to check our [blog post](../../../blog/async-features-with-docker-compose) for a detailed walkthrough on starting Async features on docker-compose. + +If you're feeling lucky regarding your machine, you can even add the [Kafdrop](https://github.com/obsidiandynamics/kafdrop) utility to visualize and troubleshoot Kafka messages with this command: + +```sh +docker compose -f docker-compose.yml -f docker-compose-async-addon.yml -f kafdrop-addon.yml up -d +``` + +## Development mode + +A development oriented mode, without the Keycloak service is also available thanks to: + +```sh +docker compose -f docker-compose-devmode.yml up -d +``` + +This configuration enabled Asynchronous API features in a very lightweight mode using [Red Panda broker](https://redpanda.com/) instead of full-blown Apache Kafka distribution. + +## Wrap-up + +You just installed Microcks on your local machine using terminal commands. Congrats! 🎉 + +You have discover that Microcks provides a bunch of default profiles to use different capabilities of Microcks depending on your working situation. Advanced profiles are using local configuration files mounted from the `/config` directory. You can refer to the [Application Configuration Reference](/documentation/references/configuration/application-config) to get the full list of configuration options. \ No newline at end of file diff --git a/content/documentation/guides/installation/docker-desktop-extension.md b/content/documentation/guides/installation/docker-desktop-extension.md index 1fc6f4f4..4b86f8de 100644 --- a/content/documentation/guides/installation/docker-desktop-extension.md +++ b/content/documentation/guides/installation/docker-desktop-extension.md @@ -3,11 +3,11 @@ draft: false title: "As a Docker Desktop Extension" date: 2024-04-30 publishdate: 2024-04-30 -lastmod: 2024-04-30 +lastmod: 2024-05-24 weight: 1 --- -This guide show you how to install Microcks as a Docker Desktop Extension on your local machine. This way of isntalling Microcks is very convenient for people wanted to start quickly with most common Microcks capabilities and without hitting the terminal 👻 +This guide shows you how to install Microcks as a Docker Desktop Extension on your local machine. This way of installing Microcks is very convenient for people wanted to start quickly with most common Microcks capabilities and without hitting the terminal 👻 [Docker Desktop](https://docs.docker.com/desktop/) is a simple-to-install application for [Mac](https://www.docker.com/products/docker-desktop/), [Windows](https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe), or [Linux](https://docs.docker.com/desktop/linux/install/) that allows you to create and share containerized applications and microservices. Docker Desktop includes the Docker Engine, the Docker CLI client, Docker Compose, Docker Content Trust, Kubernetes, and the Credential Helper.