Resource reference

The sections below (ordered in the same fashion as the Manage API docs provide information about each resource type that ml-gradle supports.

Each section defines where resource payload files should be replaced, relative to a configuration directory. ml-gradle defaults to a single configuration directory of "src/main/ml-config".

Each resource is deployed via the Manage server on port 8002, unless otherwise noted. And the connection to port 8002 is made using the user specified by mlManageUsername, or mlUsername if mlManageUsername is not set, unless otherwise noted.

Alerting

• API Docs
• Paths = ./alert, and ./databases/(name of database)/alert
• Example project, and an example of database-specific alerting

App servers

• API Docs
• Path = ./servers
• Example files

Clusters

• API Docs
• Path = ./clusters
• Example file

CPF

• API Docs
• Path = ./cpf
• Example project

Databases

• API Docs
• Path = ./databases
• Example files
• Properties

If your application deploys a REST API server, ml-gradle will look for "./databases/content-database.json" as the content database to use for this REST API server. This allows for the database to be created with a certain number of forests before the call to /v1/rest-apis.

Note that some resources can be defined in directories under "./databases/(name of database)" - see this ml-app-deployer Wiki page for more information.

Flexible Replication

• API Docs
• Path = ./flexrep, and ./database/(name of database)/flexrep
• Example project

Forests

ml-gradle creates forests when it deploys a database. See Creating forests for the different ways that forests can be created, which also includes how replicas are created.

• API Docs
• Path (for custom forests) = ./forests/(name of database)
• Example project for custom forests

Groups

• API Docs
• Path = ./groups
• Example file

Mimetypes

• API Docs
• Path = ./mimetypes
• Example file

Modules

Modules are not a Manage API resource, but rather documents loaded via a MarkLogic REST server. See How modules are loaded for more information.

REST APIs

MarkLogic provides an endpoint for creating a REST server, a content database, and a modules database in a single call. The endpoints for these are listed under the "Client API" in the REST API docs, but they are invoked on port 8002 as part of the Manage API. Thus, they're treated as another resource type that ml-gradle can deploy and undeploy.

• API Docs
• Path = ./rest-api.json . ml-gradle will look for this specific file when it calls the REST endpoint for creating a REST API server.
• Example file

Scheduled Tasks

• API Docs
• Path = ./tasks
• Example files

Schemas

Schemas are not a Manage API resource, but rather documents loaded via a MarkLogic REST server. See Loading schemas for more information.

Security - Amps

• API Docs
• Path = ./security/amps
• Example file

Security - Certificate Authorities

• API Docs
• Path = ./security/certificate-authorities
• Example file

Security - Certificate Templates

• API Docs
• Path = ./security/certificate-templates
• Example file

Security - External Security

This resource type is supported on ML8 but not yet ML9.

• API Docs
• Path = ./security/external-security
• Example file

Security - Privileges

• API Docs
• Path = ./security/privileges
• Example file

Security - Protected Collections

• API Docs
• Path = ./security/protected-collections
• Example file

Security - Protected Paths

• API Docs
• Path = ./security/protected-paths
• Example file

Security - Query Rolesets

• API Docs
• Path = ./security/query-rolesets
• Example file

Security - Roles

• API Docs
• Path = ./security/roles
• Example project

Security - Users

• API Docs
• Path = ./security/users
• Example files

SQL Schemas and Views

Note that TDE in ML9 is an alternative to SQL view schemas.

• API Docs
• Path = ./view-schemas, and ./databases/(name of database)/view-schemas
• Example files

Temporal

• API Docs
• Path = ./temporal, and ./databases/(name of database)/temporal
• Example project
• Example project with LSQT

Triggers

• API Docs
• Path = ./triggers
• Example project