You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-14Lines changed: 10 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,24 @@
1
-
# Amplify Flow Manager (2.0) Deploy
1
+
# Amplify Flow Manager (2.0)
2
2
3
3
Deploy Amplify Flow Manager on multiple container orchestration systems.
4
4
5
-
## Docker-compose
5
+
## Docker
6
6
7
-
The files needed to run Flow Manager 2.0 orchestrated with docker-compose in a single-node environment can be found in [docker-compose](docker-compose/) folder.
8
-
9
-
## Kubernetes
10
-
11
-
All deployment manifest files (standard and Helm) can be found in [kubernetes](kubernetes/) folder.
7
+
The configuration files and scripts needed to deploy Flow Manager using Docker can be found in the [docker-compose](docker-compose/) directory.
12
8
13
9
## Podman
14
10
15
-
Deployment manifest files can be found [here](podman/).
11
+
The configuration files and scripts needed to deploy Flow Manager using Podman can be found in the [podman](podman/) directory.
12
+
13
+
## Kubernetes
16
14
17
-
### Contribute
15
+
The configuration files and scripts needed to deploy Flow Manager using Kubernetes can be found in the [kubernetes](kubernetes/) directory. The official documentation for this type of deployment can be found [here](https://docs.axway.com/bundle/FlowManager_20_allOS_en_HTML5/page/kubernetes_deployment.html).
18
16
19
-
Contributions are always welcome.
17
+
## OpenShift
20
18
21
-
* Fork the repo
22
-
* Create a pull request against master
23
-
* Be sure tests pass (if exists)
19
+
The configuration files and scripts needed to deploy Flow Manager using OpenShift can be found in the [openshift](openshift/) directory. The official documentation for this type of deployment can be found [here](https://docs.axway.com/bundle/FlowManager_20_allOS_en_HTML5/page/openshift_v2_deployment.html).
24
20
25
-
Check [GitHub Flow](https://guides.github.com/introduction/flow/) for details.
21
+
Information on the Flow Manager OpenShift v1 deployment (legacy) can be found [here](https://docs.axway.com/bundle/FlowManager_20_allOS_en_HTML5/page/openshift_v1_deployment__legacy_.html).
* Get the zip file from [here](https://github.com/Axway/docker-flowmanager/archive/master.zip) and unzip it
30
-
* Go to `docker-compose` path
31
-
* Add license file in `files/flowmanager/license`
32
-
* Run `./flowmanager_helper.sh setup` command. This will generate, add certificates in configs space and create a `.env` file (to add your certificates check __[Add your own certificates files](#add-your-own-certificates-files)__ section for more information)
33
-
* Change `.env` file values, following env.template, add other parameters based on your needs or leave them as default
34
-
* After you done, run `./flowmanager_helper.sh start`. This will start the containers with Flow Manager and database
35
-
* Check the health of the services by typing this `./flowmanager_helper.sh status` command.
36
-
37
-
### Add your own certificates files
38
-
39
-
* Add your own certificates in `files/flowmanager/configs` dir
40
-
* Replace the current certificates name with yours in `.env` file
41
-
* Run `./flowmanager_helper.sh start` command to start the containers with Flow Manager and database
42
-
* Check the health of the services by typing this `./flowmanager_helper.sh status` command.
43
-
44
-
***Note***: We support for the momment `jks`,`p12` and `pem` certificates extensions.
45
-
46
-
## ***Upgrade***
47
-
48
-
* Be sure you are in the same `docker-compose` path
49
-
* In `.env` file that you already have from `Run` section, change `FLOWMANAGER_VERSION` with the newer version
50
-
* Type `./flowmanager_helper.sh start` command, this will do the updating of your container with the new version
51
-
* Check the health of the services by typing this `./flowmanager_helper.sh status` command.
52
-
53
-
## ***Remove***
54
-
55
-
* Be sure you are in the same `docker-compose` path
56
-
* Type `./flowmanager_helper.sh delete`, this will remove all the containers, volumes and other parts related to the containers.
57
-
58
-
***WARNING***: Running `./flowmanager_helper.sh delete` will remove all the volumes, including Mongodb data.
59
-
60
-
```text
61
-
./flowmanager_helper.sh is a helper script for run operations easily. If you are familiar with docker you can still use docker-compose commands.
62
-
```
63
-
64
-
### Extra configuration
65
-
66
-
#### Flow Manager parameters
67
-
68
-
The file `env.template` contains basic parameters that can be configured at Flow Manager start. The extended list can be consulted below. In order to add a new parameter, simply add it in your `.env` file and will be considered at Flow Manager.
69
-
70
-
All active Environment variables/parameters for Flow Manager, including all the services required to run can be found [here](../docs/README.md).
71
-
72
-
#### Enable transport encryption (TLS/SSL) for Mongodb
73
-
74
-
Encrypt all of Mongodb’s network traffic. TLS/SSL ensures that Mongodb network traffic is only readable by the intended client.
75
-
76
-
* Go to `docker-compose/files/mongo/config` path
77
-
* Uncomment `ssl` block from `mongod.conf` file
78
-
* Bring or generate certificate files in path you already are
79
-
* Change value of `CAFile` and `PEMKeyFile` parameters with yours (only name of certificate files)
80
-
* Save it
81
-
* Run `./flowmanager_helper.sh start` command in case you run Mongodb for the first time or `./flowmanager_helper.sh restart mongodb` in case you already have Mongodb up.
82
-
83
-
## ***Upgrade Mongo 3.6 to 4.2***
84
-
85
-
* Run [upgradeMongo42.sh](../scripts/upgradeMongo42.sh).
86
-
87
-
## ***Migrate old Docker Compose model to .env file model***
88
-
### Prerequisites:
89
-
- Install [yq](https://github.com/mikefarah/yq) on your machine
90
-
- Clone the latest version of [docker-flowmanager](https://github.com/Axway/docker-flowmanager)
91
-
- Have the old Mongo database up and running in the container
92
-
93
-
### Usage
94
-
The migration script will perform the following actions:
95
-
- Generate a _.env_ file based on the old Docker Compose environment variables
96
-
- Export data from the old database using [mongodump](https://docs.mongodb.com/database-tools/mongodump/) and store it in the current directory in a binary file named _db.dump_.
97
-
- Start the new Mongo database in a Docker container and import data from _db.dump_ file using [mongorestore](https://docs.mongodb.com/database-tools/mongorestore/)
98
-
- Stop the Docker container
99
-
```
100
-
./flowmanager_helper.sh migrate
101
-
```
102
-
The user will be asked to insert the absolute or relative path to the directory where the old Docker Compose file is located.
103
-
104
-
### Start Flow Manager Docker container
105
-
To be able to start Flow Manager with the new setup you have to:
106
-
- Copy all the certificates from the old installation to the new location according to the documentation
107
-
- Edit the variables in the _.env_ file that suit your needs. The values that contain paths should be modified as seen in the _env.template_ file.
1
+
# Docker
2
+
3
+
The official documentation for the Flow Manager Docker deployment can be found [here](https://docs.axway.com/bundle/FlowManager_20_allOS_en_HTML5/page/docker_deployment.html).
0 commit comments