Deployment using JAR file

This section describes how to run the Access Decision Service (ADS) application using its .jar file.

ADS supports the following commands:

• check

  To parse and validate the deployment configuration of the application.

• server

  To initialize the service.

Before proceeding to the deployment of ADS make sure that you have properly configured deployment.yaml as described in Basic configuration.

Download the JAR file

1. Make sure that your AWS CLI account is properly set up.

2. Execute the following command in your terminal to download the ADS .jar file:

   aws s3api get-object --bucket axiomatics-customer-artifacts --key releases/com/axiomatics/access-decision-service/2.1.1/access-decision-service-2.1.1.jar access-decision-service-2.1.1.jar

   This command will save the .jar file to your computer.

Validate the deployment configuration file

1. Validate your deployment.yaml file using the check command:

   java -jar access-decision-service-2.1.1.jar check <path_to_file>/deployment.yaml

   This verifies that the deployment configuration, user file, and license file are correctly set.

2. Any errors will be output to stderr. For example:

   <path_to_file>/deployment.yaml has an error:
   * license License is corrupt or not valid: <path_to_file>/file

   If no errors occur, an "OK" message will display.

Deploy the application

The instructions below describe how to deploy and start the ADS application.

Prepare to deploy

To start the application, you need the following:

• ADS JAR file

  This is the .jar file you downloaded in the previous steps.

• Deployment configuration file

  The deployment.yaml file contains the deployment configuration, including file references to a domain and a valid license, as described in the section Basic configuration.

  Important

  deployment.yaml should be in the same folder as the ADS JAR file.

• Additional JAR files (optional)

  If you want to include additional resources to your deployment, such as a JDBC driver or attribute connectors, you must place all relevant .jar files within a lib folder that you create. The required file structure is the following:

  ├─ access-decision-service-2.1.1.jar
  ├─ deployment.yaml
  ├─ lib
      ├─ sql-attribute-connector-<sql_ac_version>.jar
      ├─ jbdc-driver.jar

  Read the Attribute Connectors section to learn more about attribute connectors.

  note

  The SQL and Table attribute connectors require a JDBC driver to connect to the database.

Start the application

To start the deployment process, execute the following command:

Linux

java -jar <path_to_file>/access-decision-service-2.1.1.jar

Windows

java -jar <path_to_file>\access-decision-service-2.1.1.jar

important

Make sure to execute the java command from the directory that contains the deployment.yaml and the lib folder.

Verify that ADS is running

To verify that ADS is running smoothly, you can run a simple healthcheck by running a GET request:

  GET http://localhost:8081/health

This will result in Status: 200 OK with a JSON reply indicating overall system health, component statuses (probes), and relevant details like the following example:

{
    "status": "UP",
    "components": {
        "diskSpace": {
            "status": "UP",
             "details": {
            ...
            }
        },
        "liveness": {
            "status": "UP",
            "details": {
                ...
                }
            }
        },
        "ping": {
            "status": "UP"
        },
        "readiness": {
            "status": "UP",
            "details": {
                ...
                }
            }
        },
        "startup": {
            "status": "UP"
        }
    },
    "groups": [
        "customProbes"
    ]
}

See also the section Healthcheck endpoint for more information.

See System information endpoint about how to access system information data through an administration endpoint.

Next steps

• Further customize the basic deployment configuration file (deployment.yaml) to suit your specific needs. Refer to Basic configuration for more information.
• Explore additional configuration options to optimize your ADS implementation. See the section Additional configuration for more information