Skip to content

Commit

Permalink
Updated the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Sumudu-Sahan committed May 16, 2022
1 parent d527a15 commit 0e2045f
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,28 @@ Thank you for using the APIM Deployer script to deploy the API Manager 4.0.0 in

## For MAC OS users can use the below command to deploy the API Manager 4.0.0 in fully distributed way.

###FORMAT
### FORMAT
```sh APIM_DEPLOYER_MAC.sh -f <APIM_ZIP_PATH>/<APIM_ZIP_FILE_NAME> -z <APIM_ZIP_FILE_NAME> -b wso2am-4.0.0 -d <DEPLOYMENT_PATTERN> -r <MYSQL_ROOT_USERNAME> -p <MYSQL_ROOT_PASSWORD> -c <JDBC_CONNECTOR_JAR_LOCATION>/<JDBC_CONNECTOR_JAR_NAME> -a <APIM_DATABASE_NAME> -s <SHARED_DATABASE_NAME> -u <UPDATE_LEVEL_TO_INSTALL>```

###EXAMPLE
```sh APIM_DEPLOYER_MAC.sh -z <APIM_ZIP_FILE_NAME> -b wso2am-4.0.0 -d <DEPLOYMENT_PATTERN> -r <MYSQL_ROOT_USERNAME> -p <MYSQL_ROOT_PASSWORD> -a <APIM_DATABASE_NAME> -s <SHARED_DATABASE_NAME> -u <UPDATE_LEVEL_TO_INSTALL>```

### EXAMPLE
```sh APIM_DEPLOYER_MAC.sh -f /home/sumudu/.wum3/products/wso2am/4.0.0/wso2am-4.0.0.zip -z wso2am-4.0.0.zip -b wso2am-4.0.0 -d FULL -r root -p PASSWORD -c /home/sumudu/.wum3/products/wso2am/mysql-connector-java-8.0.27.jar -a TEST_APIM_DB -s TEST_SHARED_DB -u 91```

```sh APIM_DEPLOYER_MAC.sh -z wso2am-4.0.0.zip -b wso2am-4.0.0 -d FULL -r root -p PASSWORD -a TEST_APIM_DB -s TEST_SHARED_DB -u 91```

## For Linux OS users can use the below command to deploy the API Manager 4.0.0 in fully distributed way.

###FORMAT
### FORMAT
```sh APIM_DEPLOYER_LINUX.sh -f <APIM_ZIP_PATH>/<APIM_ZIP_FILE_NAME> -z <APIM_ZIP_FILE_NAME> -b wso2am-4.0.0 -d <DEPLOYMENT_PATTERN> -r <MYSQL_ROOT_USERNAME> -p <MYSQL_ROOT_PASSWORD> -c <JDBC_CONNECTOR_JAR_LOCATION>/<JDBC_CONNECTOR_JAR_NAME> -a <APIM_DATABASE_NAME> -s <SHARED_DATABASE_NAME> -u <UPDATE_LEVEL_TO_INSTALL>```

###EXAMPLE
```sh APIM_DEPLOYER_LINUX.sh -z <APIM_ZIP_FILE_NAME> -b wso2am-4.0.0 -d <DEPLOYMENT_PATTERN> -r <MYSQL_ROOT_USERNAME> -p <MYSQL_ROOT_PASSWORD> -a <APIM_DATABASE_NAME> -s <SHARED_DATABASE_NAME> -u <UPDATE_LEVEL_TO_INSTALL>```

### EXAMPLE
```sh APIM_DEPLOYER_LINUX.sh -f /home/sumudu/.wum3/products/wso2am/4.0.0/wso2am-4.0.0.zip -z wso2am-4.0.0.zip -b wso2am-4.0.0 -d FULL -r root -p PASSWORD -c /home/sumudu/.wum3/products/wso2am/mysql-connector-java-8.0.27.jar -a TEST_APIM_DB -s TEST_SHARED_DB -u 91```

```sh APIM_DEPLOYER_LINUX.sh -z wso2am-4.0.0.zip -b wso2am-4.0.0 -d FULL -r root -p PASSWORD -a TEST_APIM_DB -s TEST_SHARED_DB -u 91```

## Flags
`-v` => To get the version of this script

Expand All @@ -37,7 +45,7 @@ Eg: \n sh APIM_DEPLOYER_<OS>.sh -h
- FULL => Traffic Manager separated deployment. (Control Plane, Traffic Manager and Gateway Worker)
- GWCP => Gateway Worker and Control Plane deployment. (Control Plane and Gateway Worker)

`-f` => Base pack location path
`-f` => Base pack location path (Optional)

`-z` => ZIP file name of the APIM pack (Eg: wso2am-4.0.0.zip)

Expand All @@ -47,7 +55,7 @@ Eg: \n sh APIM_DEPLOYER_<OS>.sh -h

`-p` => Root user password of the MySQL server

`-c` => Path of the MySQL JDBC connector Jar
`-c` => Path of the MySQL JDBC connector Jar (Optional)

`-a` => APIM database name

Expand Down

0 comments on commit 0e2045f

Please sign in to comment.