Deploying an Application to Oracle Application Container Cloud Service

This view is the default view for an application. It shows the number of running instances, instance memory size, instance metadata (for example, the time that the instance was started), and application metadata (for example, Java version, date and time deployed, and identity domain):

This view shows information about the current application’s deployment. The view focuses on configuration data which includes application metadata (for example, archive name and archive size), service bindings to other cloud services, global environment variables, the launch command for your instances, and the configuration files for each application instance (the manifest.json and deployment.json files are linked here).

The Administration View allows you to manage the underlying technology version you are using for your application. In this case, the tab allows you to choose the Java version you are using. You can upgrade to a new version of Java or roll back to an older version.

This view stores application-related log and performance information.

On the Logs tab, you can generate the log file from your instances and then download it to your local machine. You can also view a history of log captures.

On the Recordings tab, you can use Java Flight Recorder to record one minute of your application’s performance data, download the recording to your local machine, and analyze it in Java Mission Control.

Before you can deploy your application, you must copy it to the storage service. You need your Oracle Cloud service credentials (User ID, password, ID domain) to use the REST API. With your credentials, you create cURL scripts to upload your application to the storage service.

Here are sample values that are used in the cURL script examples that follow. You'll use your own values instead of the sample values if you upload your own application.

• App Name: EmployeeWebApp
• Archive File Name: employees-web-app.zip
• Path to Local File: target/employees-web-app.zip
• User Name: johndoe
• Password: johnpassword
• Identity Domain: john-acct01
• Host Name: apaas.us.oraclecloud.com

This example shows the script structure that creates a storage container:

# CREATE STORAGE CONTAINER
curl -i -X PUT \
  -u User-Name:Password \
  https://hostname/v1/Storage-Identity-Domain/App-Name

After you create the storage container, you can upload your application archive to the storage container.

This example shows the script structure that uploads your application archive to the storage container:

# PUT ARCHIVE IN STORAGE CONTAINER
curl -i -X PUT \
-u User-Name:Password \
https://hostname/v1/Storage-Identity-Domain/App-Name/Archive-File-Name -T Path-to-local-file/Archive-File-Name

This example script uses the provided sample values to create the storage container:

# CREATE STORAGE CONTAINER
curl -i -X PUT \
  -u johndoe:johnpassword \
  https://storage.oraclecloud.com/v1/Storage-john-acct01/EmployeeWebApp

This example script uses the provided sample values to upload the sample application to the storage service:

# PUT ARCHIVE IN STORAGE CONTAINER
curl -i -X PUT \
  -u johndoe:johnpassword \
  https://storage.oraclecloud.com/v1/Storage-john-acct01/EmployeeWebApp/employees-web-app.zip -T target/employees-web-app.zip

To deploy your application, you need to include standard information in your script. The following example script shows placeholders for the required information:

# Mock Deployment Script
url -i -X POST  \
  -u User-Name:Password \
  -H "X-ID-TENANT-NAME:Identity-Domain" \
  -H "Content-Type: multipart/form-data" \
  -F "name=App-Name" \
  -F "runtime=java" \
  -F "subscription=Monthly" \
  -F "deployment=@deployment.json" \
  -F "archiveURL=App-name/Archive-File-Name" \
  -F "notes=Your Notes here" \
  https://hostname/paas/service/apaas/api/v1.1/apps/Identity-Domain

Here are a few key points about this example:

• -H specifies headers that are added to the HTTP request.
• -F allows cURL to submit data like it's coming from a form (so, POST as the HTTP method).
• archiveURL specifies where your archive file is located. The URL consists of your application's name, a slash, and the archive's file name.

Note: Rather than using default values for your application, you can specify the deployment.json file at deployment.

Here's a sample deployment script that contains actual data, including the deployment.json file:

# Deployment Script
url -i -X POST  \
  -u johndoe:johnpassword \
  -H "X-ID-TENANT-NAME:john-acct01" \
  -H "Content-Type: multipart/form-data" \
  -F "name=EmployeeWebApp" \
  -F "runtime=java" \
  -F "subscription=Monthly" \
  -F "deployment=@deployment.json" \
  -F "archiveURL=EmployeeWebApp/employees-web-app.zip" \
  -F "notes=REST app for testing" \
  https://apaas.us.oraclecloud.com/paas/service/apaas/api/v1.1/apps/john-acct01
 

After your application is deployed to Oracle Application Container Cloud Service, view any application details in the web GUI.

When you deploy your application, you can reference a deployment.json file. The file provides configuration settings for the container that your application runs in. The settings include the memory size of the application and specific information about the environment.

Example deployment.json File

{
    "memory": "2G",
    "instances": "1",  
    "environment": {
        "NO_OF_CONNECTIONS":"25",
        "TWITTER_ID":"JAVA"
    },
    "services": [{
        "identifier": "ProdService",
        "name": "Jaas Service",
        "type": "JAAS"
        "username": "username",
        "password": "***"  
    }]
}

JSON Fields

• memory defines the size of the applications container. Valid values are 1G to 7G.
• instances are the number of application instances to run.
• notes are notes about the deployment plan.
• environment:
  • key is the name of an environment variable that the application uses.
  • value is the value of the environment variable that the application uses.
• services:
  • identifier is the user-defined name.
  • name is the name of the service.
  • type is the type of service.
  • username is the name used to access the service (optional).
  • password is the password for the service (optional).

Here's the actual deployment.json file used for an application:

{
    "memory": "2G",
    "instances": "1",
    "environment":{
        "TEST_ENV_VAR": "TestValue"
    }
}

When you deploy the application, just reference the file in the cURL script. Then the file's settings are used to deploy the application.

To update your application's deployment configuration, execute a command like the following:

curl -X PUT \
-u johndoe:johnpassword \
-H "X-ID-TENANT-NAME:john-acct01" \
-H "Content-Type: multipart/form-data"\
-F deployment=@deployment.json" \
-F "notes=notes for deployment" \
	https://apaas.us.oraclecloud.com/paas/service/apaas/api/v1.1/apps/john-acct01/EmployeeWebApp

In the URL, the identity domain and the application’s name specify what is updated. The deployment.json file contains your changes to the configuration. Changes restart your application or start new instances.

To update the entire application, use the following command:

curl -X PUT \
-u johndoe:johnpassword \
-H "X-ID-TENANT-NAME:john-acct01" \
-H "Content-Type: multipart/form-data"\
-F "deployment=@deployment.json" \
-F "archiveURL=/EmployeeWebApp/employees-web-app.zip" \
-F "notes=notes for deployment" \
https://apaas.us.oraclecloud.com/paas/service/apaas/api/v1.1/apps/john-acct01/EmployeeWebApp

In the URL, the identity domain and the application’s name specify what is updated. The deployment.json file contains your changes to the configuration, but the file isn’t required. If you don’t want to change the deployment settings, don’t specify a file. In this case, your application restarts.