IBM Services Software Archive and Essence Manager Pak

https://www.ibm.com/docs/en/arema/1.0
Admin
IBM AREMA is a software archive and essence manager solution that provides tools for managing and...
Tokens:66,426
Snippets:595
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Order Configuration Example in JavaScript

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-order

This JavaScript code snippet shows an example configuration for AREMA orders. It defines 'targets' for master import and export, including metadata like project and location selection, and an 'actions' section for starting a job via an AREMA REST call. It's important to use Kubernetes-valid names for hostnames and URLs.

```javascript
module.exports = {
  settings: {
    targets: [
      {
        id: "ep_order_master_import",
        name: "Master Import",
        // it is recommendeded to use only names that are valid in Kubernetes when configuring host names and URLs
        templatePath: workflowBuilderUrl + "master-import",
        usecase: ["remoteUpload"],
        needData: true,
        metadata: [
          {
            type: "select",
            id: "project",
            name: "Project",
            needData: true,
            url: "/api/projectsetup/getProjectsForOrder/",
            dependents: "entity_location",
          },
          {
            type: "select",
            id: "entity_location",
            for: "remoteFileUpload",
            name: "Import Location",
            url: "/api/projectsetup/getEntitiesForOrder/entity_location/true/",
            appendParent: true,
          }
        ]
      },
      {
        id: "ep_order_master_export",
        name: "Master Export",
        templatePath: workflowBuilderUrl + "master-export",
        usecase: ["normal"],
        metadata: [
          {
            type: "select",
            id: "project",
            name: "Project",
            needData: true,
            url: "/api/projectsetup/getProjectsForOrder/",
            dependents: "entity_location",
          },
          {
            type: "select",
            id: "entity_location",
            name: "Location",
            url: "/api/projectsetup/getEntitiesForOrder/entity_location/true/",
            appendParent: true,
          }
        ]
      }
    ],
    actions: [
      {
        id: "aremaRestCall",
        name: "Start Job",
        properties: {
          id: "template_variables",
        },
        admira: {
          version: "2.0.0",
          type: "parameters",
        },
      }
    ]
  }
};
```

--------------------------------

### Example: Encrypt string with cryptoUtil.js

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-global-configuration

Provides an example of encrypting a string using the `cryptoUtil.js` script. The output is the encrypted string, which is shown to be used in configuration.

```bash
node utils/cryptoUtil.js encrypt my_password
7cf0951e427788533dcf13   <- the encrypted string
```

--------------------------------

### Install Kubernetes CLI (kubectl) using CURL

Source: https://www.ibm.com/docs/en/arema/1.0?topic=environment-install-required-software-installation

Installs the kubectl command-line tool using CURL. This tool interfaces with the Kubernetes REST API. It downloads the latest stable version, makes it executable, and moves it to the system's PATH.

```bash
# Install using CURL
$ curl -LO https://storage.googleapis.com/kubernetes-release/release/`curl \
    -s https://storage.googleapis.com/kubernetes-release/release/stable.txt`/bin/linux/amd64/kubectl
$ chmod +x ./kubectl
$ sudo mv ./kubectl /usr/local/bin/kubectl
$ kubectl version --client
```

--------------------------------

### Example: Decrypt string with cryptoUtil.js

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-global-configuration

Provides an example of decrypting a string using the `cryptoUtil.js` script. It takes the encrypted string as input and outputs the original, decrypted string.

```bash
node utils/cryptoUtil.js decrypt 7cf0951e427788533dcf13
my_password   <- the decrypted string
```

--------------------------------

### Get All Resources in a Namespace using kubectl

Source: https://www.ibm.com/docs/en/arema/1.0?topic=arema-backup-installed-resources

This command retrieves all available resources within a specified Kubernetes namespace. It includes common resource types like pods, deployments, and ReplicaSets, but may not encompass all resource types. This is useful for creating a comprehensive backup of the current state.

```bash
# kubectl get [resource] -> pod, service, serviceaccount, route, deployment, ...
# Display all resources in a namespace
# "all" includes pod, deployment, replicaset, …
# Note: some resources are not contained in "all"
$ kubectl get all
```

--------------------------------

### Install Docker CE using YUM

Source: https://www.ibm.com/docs/en/arema/1.0?topic=environment-install-required-software-installation

Installs Docker Community Edition (Docker CE) on CentOS/RHEL systems using YUM. This includes setting up the Docker repository, installing the necessary packages, starting the Docker service, and optionally adding the current user to the docker group to run Docker without sudo.

```bash
# Install docker-ce
$ sudo yum install -y yum-utils
$ sudo yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
$ sudo yum install docker-ce docker-ce-cli containerd.io

# Start docker
$ sudo systemctl start docker

# To run docker without using sudo add the user to the docker group
$ sudo usermod -aG docker your-user
```

--------------------------------

### Generic Helm Installation Command

Source: https://www.ibm.com/docs/en/arema/1.0?topic=arema-perform-helm-installation

The standard command structure for installing a Helm chart. It requires the chart name and optional flags to configure the deployment.

```bash
helm install [CHART] [flags]
```

--------------------------------

### Verify Installation Status with kubectl

Source: https://www.ibm.com/docs/en/arema/1.0?topic=installation-license-service-kubernetes

These `kubectl` commands verify that the IBM Licensing Operator has been successfully installed and is running. It checks the ClusterServiceVersion (CSV) for a 'Succeeded' phase and confirms the deployment status.

```bash
$kubectl get clusterserviceversion -n $NAMESPACE
NAME                            DISPLAY                  VERSION   REPLACES                        PHASE
ibm-licensing-operator.v1.6.0   IBM Licensing Operator   1.6.0     ibm-licensing-operator.v1.5.0   Succeeded

$kubectl get deployment -n $NAMESPACE | grep ibm-licensing-operator
NAME                             READY   UP-TO-DATE   AVAILABLE   AGE
ibm-licensing-operator           1/1     1            1           39m

```

--------------------------------

### Install Kubernetes CLI (kubectl) using YUM

Source: https://www.ibm.com/docs/en/arema/1.0?topic=environment-install-required-software-installation

Installs the kubectl command-line tool using the YUM package manager for CentOS or RHEL systems. It configures the Kubernetes repository and then installs kubectl.

```bash
# Install using native package management for CentOS or RHEL
$ cat <<EOF > /etc/yum.repos.d/kubernetes.repo
[kubernetes]
name=Kubernetes
baseurl=https://packages.cloud.google.com/yum/repos/kubernetes-el7-x86_64
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://packages.cloud.google.com/yum/doc/yum-key.gpg https://packages.cloud.google.com/yum/doc/rpm-package-key.gpg
EOF
$ yum install -y kubectl
```

--------------------------------

### Install Git using YUM

Source: https://www.ibm.com/docs/en/arema/1.0?topic=environment-install-required-software-installation

Installs Git, a version control system, using the YUM package manager. Git is used by AREMA images for injecting custom configurations and managing configuration injection.

```bash
# Install Git, using the standard package manager
$ yum install git
```

--------------------------------

### Install Kubernetes Service Plugin (IBM Cloud CLI)

Source: https://www.ibm.com/docs/en/arema/1.0?topic=environment-install-required-software-installation

This command installs the Kubernetes Service plugin for the IBM Cloud CLI. Ensure you have the IBM Cloud CLI installed and configured before running this command. This plugin enables management of Kubernetes clusters and related services through the CLI.

```bash
ibmcloud plugin install kubernetes-service
```

--------------------------------

### Install Node.js 12

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-global-configuration

Installs Node.js version 12 using the dnf package manager. This command is typically run on systems that use dnf, such as Fedora or CentOS.

```bash
sudo dnf module install nodejs:12
```

--------------------------------

### Add Multiple Parameters to Job Start

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-task-module

Demonstrates how to extend the selected_fields array to include multiple parameters for the workflow job.

```javascript
"selected_fields": ['task_id', 'my_parameter1', 'my_parameter2']
```

--------------------------------

### Install Jenkins Helm Chart

Source: https://www.ibm.com/docs/en/arema/1.0?topic=deployment-installation-jenkins-kubernetes

Installs the Jenkins Helm chart with specified configurations. It requires the Helm CLI and a Kubernetes cluster. The command uses a values file to define persistence, service account, and ingress settings.

```bash
$ helm install "jenkins" jenkinsci/jenkins \
    --namespace arema-cloud \
    --debug \
    --values arema-jenkins-values.yaml

```

--------------------------------

### Create Subscription using kubectl

Source: https://www.ibm.com/docs/en/arema/1.0?topic=installation-license-service-kubernetes

This code defines and applies a Subscription resource to a specified namespace using `kubectl`. The Subscription tells OLM which operator to install, from which source, and on which channel.

```yaml
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: ibm-licensing-operator-app
  namespace: $NAMESPACE
spec:
  channel: v3
  name: ibm-licensing-operator-app
  source: opencloud-operators
  sourceNamespace: $GLOBAL_CATALOG_NAMESPACE

```

--------------------------------

### Install Helm 3 using CURL

Source: https://www.ibm.com/docs/en/arema/1.0?topic=environment-install-required-software-installation

Installs Helm 3, a package manager for Kubernetes, using CURL. This process involves downloading the binary, extracting it, and moving the Helm executable to the system's PATH. Helm 3 is required for rendering Helm Charts and installing AREMA.

```bash
# Install using CURL
$ curl -LO https://get.helm.sh/helm-v3.5.3-linux-amd64.tar.gz
$ tar -zxvf helm-v3.5.3-linux-amd64.tar.gz
$ sudo mv linux-amd64/helm /usr/local/bin/helm
```

--------------------------------

### Make Script Executable

Source: https://www.ibm.com/docs/en/arema/1.0?topic=arema-perform-helm-installation

Command to change the permissions of the installation script to make it executable.

```bash
chmod a+x helm-arema-install.sh
```

--------------------------------

### AREMA Helm Installation Script

Source: https://www.ibm.com/docs/en/arema/1.0?topic=arema-perform-helm-installation

A bash script template for deploying the AREMA Helm chart. It defines variables for the chart path, values file, namespace, and timeout, and executes the installation with debug and dry-run options.

```bash
#!/bin/bash
# Name of the script: helm-arema-install.sh
HELM_CHART="/path/to/helm/arema"
CUSTOMER_VALUES="/path/to/customer/helm/arema/values.yaml"
NAMESPACE="arema-cloud"
INSTALLATION_NAME="arema-production"
TIMEOUT="10m"

helm install \
    --dry-run \
    $INSTALLATION_NAME \
    --namespace $NAMESPACE \
    --values $CUSTOMER_VALUES \
    --debug \
    --timeout $TIMEOUT \
    $HELM_CHART
```

--------------------------------

### Elasticsearch Document Example for Single Video

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-scene-management

This example demonstrates the necessary parameters for an Elasticsearch document containing a single video. The 'essenceType' must be 'Video', and essential fields like 'technicalKeyFrameFileName', 'technicalVideoFileName', and 'framerate' are required for video playback and keyframe display.

```json
{
  "arema_id" : 10012,
  "project" : "myProject",
  "orgunit" : "myProject",
  "essenceType" : "Video",
  "essenceTitle" : "Essence Title",
  "technicalKeyFrameFileName" : "myKFD.kfd",
  "technicalVideoFileName" : "myMP4.mp4",
  "framerate" : 30
}
```

--------------------------------

### Define Annotation Rules Schema

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-generics

Sets up metadata rules for annotations, including value generation restrictions and text input templates.

```JSON
{
  "id": "entity_annotation_rules",
  "type": "metadata",
  "multi": true,
  "quantity_type": "multi",
  "preview": true,
  "restrictions": [
    {
      "type": "value_generator",
      "disabled": true,
      "prefix": "Version_"
    }
  ],
  "template": [
    {
      "id": "ann_rules_desc",
      "type": "textinput",
      "allowSpace": true
    }
  ]
}
```

--------------------------------

### Configure Project Functions Schema

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-generics

Defines the structure for cascaded metadata functions, allowing for multi-entrance text inputs and nested options.

```JSON
{
  "id": "ps_functions",
  "type": "cascaded_metadata",
  "quantity_type": "multi",
  "template": [
    {
      "id": "function_type",
      "type": "cascaded_options",
      "template": [
        {
          "id": "entity_function",
          "preview": true,
          "multi": true,
          "quantity_type": "multi",
          "template": [
            {
              "id": "function_desc",
              "type": "textinput",
              "allowSpace": true
            }
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### Creating Jenkins Service Account, ClusterRole, and ClusterRoleBinding

Source: https://www.ibm.com/docs/en/arema/1.0?topic=deployment-installation-jenkins-kubernetes

This YAML file defines a service account for Jenkins, a ClusterRole, and a ClusterRoleBinding. This setup is required to provide Jenkins with the necessary permissions within the Kubernetes cluster, likely for managing resources related to the AREMA namespace.

```yaml
# jenkins-sa.yaml
# This file content is not provided in the input text, but the description indicates its purpose.

```

--------------------------------

### Configure Job Start Buttons in settings.js

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-task-module

Defines the structure for adding workflow initiation buttons to the Task Module. It requires a unique ID, a JOB_START type, and specific field selections to pass parameters to the workflow.

```javascript
buttons_options: [
  {
    "id": "aremaRestCall",
    "name": 'Send a REST call',
    "type": "JOB_START",
    "permission": "ep_media_access",
    "button_title": "Submit",
    "selected_fields": ['task_id'],
    "order": {
      "templatePath": workflowBuilderUrl + "annotation_result_task",
      "action": [{
        "id": 'aremaRestCall',
        "name": 'Send a REST call',
        "properties": {
          "id": 'template_variables',
        },
        "admira": {
          "version": '2.0.0',
          "type": 'parameters'
        }
      }]
    }
  }
]
```

--------------------------------

### Usage of cryptoUtil.js

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-global-configuration

Demonstrates the command-line usage of the `cryptoUtil.js` script. It accepts either 'encrypt' or 'decrypt' as the first argument, followed by the string to be processed.

```bash
node cryptoUtil.js encrypt|decrypt <string>
```

--------------------------------

### POST /task

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-task-module

Creates a new task with associated metadata.

```APIDOC
## POST /task

### Description
Creates a task including its metadata.

### Method
POST

### Endpoint
https://<hostname>:<port>/task

### Request Body
- **metadata** (object) - Required - Task metadata details

### Response
#### Success Response (200)
- **status** (string) - Success confirmation
```

--------------------------------

### Create Elasticsearch Pod and Service using kubectl

Source: https://www.ibm.com/docs/en/arema/1.0?topic=logging-elastic-stack

This command applies the Kubernetes YAML file to create the Elasticsearch Deployment and Service. This makes the Elasticsearch instance accessible within the cluster.

```bash
$ kubectl create -f arema-elasticsearch-logging.yaml

```

--------------------------------

### Configure AREMA Tape Job Templates (XML)

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portlet-tapes-view

This XML configuration file defines job templates and their parameters for tape administration in AREMA. It specifies template paths, labels, descriptions, and input parameters like text fields and dropdowns. This configuration is located at `<ADMIRA_HOME>/bin/portal/conf/AREMA_portal_config.xml`.

```xml
<storagePortlet>
        <tapesView>
                <jobTemplates>
                        <jobTemplate>
                                <templatePath>/home/dmae/admira/etc/templates-ev/LTFS_Admin_Fast_LTFS_Import.xsl</templatePath>
                                <templateLabel>Admin Fast LTFS Import</templateLabel>
                                <templateInfo>Fast import LTFS tape to filesystem (import tape to the library, import the files to database).</templateInfo>
                                <parameters>
                                        <parameter name="TITLE" label="Job Title" type="text">Fast LTFS Import Admin Job</parameter>
                                        <parameter name="PRIORITY" label="Priority" type="select">
                                                <option label="LOW" value="LOW"/>
                                                <option label="MEDIUM" value="MEDIUM"/>
                                                <option label="HIGH" value="HIGH"/>
                                                <option label="CRITICAL" value="CRITICAL"/>
                                        </parameter>
                                        <parameter name="TO_IO_SLOT" label="Move cartridge to I/O Slot" type="select">
                                                <option value="no" label="no"/>
                                                <option value="yes" label="yes"/>
                                        </parameter>
                                </parameters>
                        </jobTemplate>
                </jobTemplates>
        </tapesView>
</storagePortlet>
```

--------------------------------

### Install IBM Cloud CLI

Source: https://www.ibm.com/docs/en/arema/1.0?topic=environment-install-required-software-installation

Installs the IBM Cloud CLI (ibmcloud) and the container registry plugin using CURL. This tool is required if the Kubernetes cluster is running on IBM Cloud (IKS) and provides interfaces to the Kubernetes service and container registry.

```bash
# Install ibmcloud cli
$ curl -fsSL https://clis.cloud.ibm.com/install/linux | sh

# Install plugin for container registry
$ ibmcloud plugin install container-registry
```

--------------------------------

### Create IBMLicensing Instance using kubectl

Source: https://www.ibm.com/docs/en/arema/1.0?topic=installation-license-service-kubernetes

This snippet creates an IBMLicensing instance, configuring its API token, datasource, ingress settings, and namespace. It requires retrieving the cluster's ingress subdomain first.

```yaml
# Retrieve Ingress Subdomain
$ ibmcloud ks cluster get --cluster <cluster_name_or_id> | grep Ingress
Ingress Subdomain:              <url>
Ingress Secret:                 <secret>
Ingress Status:                 healthy
Ingress Message:                All Ingress components are healthy

# Save Subdomain to variable
INGRESS_HOST=<url>

$ cat <<EOF | kubectl apply -f -
apiVersion: operator.ibm.com/v1alpha1
kind: IBMLicensing
metadata:
  name: instance
spec:
  apiSecretToken: ibm-licensing-token
  datasource: datacollector
  httpsEnable: false
  instanceNamespace: $NAMESPACE
  ingressEnabled: true
  ingressOptions:
    annotations:
      kubernetes.io/ingress.class: "public-iks-k8s-nginx"
      "nginx.ingress.kubernetes.io/rewrite-target": "/$2"
    path: /ibm-licensing-service-instance(/|$)(.*)
    host: $INGRESS_HOST
EOF

```

--------------------------------

### GET /task/{id} - Get Task By ID

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-task-module

Retrieves a specific task by its unique identifier.

```APIDOC
## GET /task/{id}

### Description
Retrieves a specific task by its unique identifier.

### Method
GET

### Endpoint
https://localhost:8888/task/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the task to retrieve.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful.
- **results** (object) - An object containing the task details.
  - **task_id** (integer) - The ID of the task.
  - **usecase_id** (string) - The ID of the use case.
  - **owner** (string) - The owner of the task.
  - **ownertype** (string) - The type of the owner.
  - **title** (string) - The title of the task.
  - **priority** (integer) - The priority of the task.
  - **stepname** (string) - The name of the current step.
  - **status_name** (string) - The name of the task status.
  - **status_code** (integer) - The code of the task status.
  - **createdAt** (string) - The creation timestamp of the task.
  - **updatedAt** (string) - The last update timestamp of the task.
  - **callback_job_id** (integer) - The ID of the callback job.
  - **callback_filename** (integer) - The filename of the callback.
  - **origin_job_id** (integer) - The ID of the origin job.
  - **orgunit** (string) - The organizational unit.
  - **process_id** (string) - The ID of the process.
  - **task_metadata** (array) - An array of metadata objects associated with the task.
    - **task_metadata_id** (integer) - The ID of the task metadata.
    - **key** (string) - The metadata key.
    - **value** (string) - The metadata value.
    - **options** (array) - An array of options for select type metadata.
    - **datatype** (string) - The data type of the metadata.
    - **group** (string) - The group the metadata belongs to.
    - **changeable** (boolean) - Indicates if the metadata is changeable.
    - **optional** (boolean) - Indicates if the metadata is optional.
    - **task_id** (integer) - The ID of the task this metadata belongs to.
    - **createdAt** (string) - The creation timestamp of the metadata.
    - **updatedAt** (string) - The last update timestamp of the metadata.
  - **task_histories** (array) - An array of task history objects.
    - **task_history_id** (integer) - The ID of the task history entry.
    - **action** (string) - The action performed.
    - **from** (object) - The state before the action.
    - **to** (object) - The state after the action.
    - **task_id** (integer) - The ID of the task.
    - **createdAt** (string) - The creation timestamp of the history entry.
    - **updatedAt** (string) - The last update timestamp of the history entry.

#### Response Example
```json
{
  "success": true,
  "results": {
    "task_id": 38,
    "usecase_id": "annotation_result",
    "owner": "dmae",
    "ownertype": "user",
    "title": "Annotation Result",
    "priority": 1,
    "stepname": "create_annotation_task",
    "status_name": "open",
    "status_code": 0,
    "createdAt": "2021-08-10T16:21:18.985Z",
    "updatedAt": "2021-08-10T16:21:18.985Z",
    "callback_job_id": 3456,
    "callback_filename": "789",
    "origin_job_id": 3333,
    "orgunit": "admira",
    "process_id": null,
    "task_metadata": [
      {
        "task_metadata_id": 2121,
        "key": "annotation",
        "value": "3D validation",
        "options": null,
        "datatype": "text",
        "group": "Task Information",
        "changeable": true,
        "optional": true,
        "task_id": 38,
        "createdAt": "2021-08-10T16:21:18.993Z",
        "updatedAt": "2021-08-10T16:21:18.993Z"
      },
      {
        "task_metadata_id": 2122,
        "key": "annotation_rule_version",
        "value": "result 02",
        "options": null,
        "datatype": "text",
        "group": "Task Selection",
        "changeable": false,
        "optional": false,
        "task_id": 38,
        "createdAt": "2021-08-10T16:21:18.993Z",
        "updatedAt": "2021-08-10T16:21:18.993Z"
      },
      {
        "task_metadata_id": 2123,
        "key": "user_selection",
        "value": 0,
        "options": [
          {
            "id": "0",
            "name": "Accepted"
          },
          {
            "id": "1",
            "name": "Rejected"
          }
        ],
        "datatype": "select",
        "group": "Task Selection",
        "changeable": true,
        "optional": true,
        "task_id": 38,
        "createdAt": "2021-08-10T16:21:18.994Z",
        "updatedAt": "2021-08-10T16:21:18.994Z"
      }
    ],
    "task_histories": [
      {
        "task_history_id": 107,
        "action": "create",
        "from": null,
        "to": null,
        "task_id": 38,
        "createdAt": "2021-08-10T16:21:18.994Z",
        "updatedAt": "2021-08-10T16:21:18.994Z"
      }
    ]
  }
}
```
```

--------------------------------

### Adding and Updating Jenkins Helm Repository

Source: https://www.ibm.com/docs/en/arema/1.0?topic=deployment-installation-jenkins-kubernetes

These Helm commands add the official Jenkins Helm repository and update it to the latest version. This is a prerequisite for installing Jenkins using Helm. It requires Helm to be installed and configured.

```bash
# Add Jenkins repository from Helm
$ helm repo add jenkinsci https://charts.jenkins.io

# Update to the current version
$ helm repo update

# Verify the repository is downloaded
$ helm search repo jenkinsci
NAME                    CHART VERSION   APP VERSION     DESCRIPTION
jenkinsci/jenkins       3.2.5           2.277.1         Jenkins - Build great things at any scale! The ...

```

--------------------------------

### Deploy Logstash via Kubernetes

Source: https://www.ibm.com/docs/en/arema/1.0?topic=logging-elastic-stack

Command to create the Logstash Pod and Service using a YAML configuration file.

```bash
kubectl create -f arema-logstash-logging.yaml
```

--------------------------------

### Configure License Metric Daemon in DMAeServer.xml

Source: https://www.ibm.com/docs/en/arema/1.0?topic=core-configure-license-metrics-daemon

Defines the XML configuration structure for the license metric daemon. It includes settings for logging (console and rolling file) and operational parameters such as report intervals and service URLs.

```xml
<cfg id="license_metrics_daemon">
	<cfg id="logging">
		<cfg id="console">
			<param name="log_pattern">%d [%t] %-5p %c - %m%n</param>
			<param name="log_threshold">INFO</param>
			<param name="log_on">false</param>
		</cfg>
		<cfg id="rolling_file">
			<param name="log_pattern">%d [%t] %-5p %c - %m%n</param>
			<param name="log_threshold">INFO</param>
			<param name="log_file_path">/home/dmae/admira/var/log/</param>
			<param name="log_file_size">5MB</param>
			<param name="log_file_daily">false</param>
			<param name="log_max_backups">5</param>
			<param name="log_compress_level">0</param>
			<param name="log_on">true</param>
		</cfg>
	</cfg>
	<param name="sleep_time">60</param>
	<param name="report_interval">86400</param>
	<param name="unhealthy_time_thread_threshold">600</param>
	<param name="license_service_url">https://ibm-licensing-service-instance</param>
	<param name="license_service_upload_token">abc123def456</param>
</cfg>
```

--------------------------------

### Configure UNC Path and Input Restrictions

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-generics

Configures input fields for UNC names and paths, including a preconfigured list of directory options and unique metadata validation constraints.

```json
{
  "id": "unc_name",
  "type": "textinput",
  "allowSpace": true
},
{
  "id": "unc_path",
  "type": "preconfigured_list",
  "values": [
    "\\AREMA",
    "\\Import",
    "\\\\Export"
  ],
  "restrictions": [
    {"type": "unique_metadata"}
  ],
  "dependents": "location_file_size"
}
```

--------------------------------

### Clone Git Repository for AREMA

Source: https://www.ibm.com/docs/en/arema/1.0?topic=environment-set-up-configuration-git-repository

This command clones a remote Git repository to the local installation host. It requires a valid repository URL and pre-configured SSH keys for authentication.

```bash
$ git clone <url>
```

--------------------------------

### GET /task/

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-task-module

Retrieves task details by ID.

```APIDOC
## GET /task/

### Description
Retrieves task details by task_id.

### Method
GET

### Endpoint
https://<hostname>:<port>/task/

### Query Parameters
- **task_id** (string) - Required - The unique identifier of the task
```

--------------------------------

### Retrieve Jenkins Admin Password

Source: https://www.ibm.com/docs/en/arema/1.0?topic=deployment-installation-jenkins-kubernetes

Retrieves the admin password for Jenkins after installation using kubectl. This command connects to the Jenkins service in the specified namespace and executes a command within the Jenkins pod to read the password file.

```bash
$ kubectl exec --namespace arema-cloud -it svc/jenkins -c jenkins -- /bin/cat /run/secrets/chart-admin-password && echo

```

--------------------------------

### Implement File Size Calculation and Thresholds

Source: https://www.ibm.com/docs/en/arema/1.0?topic=portal-generics

Defines a numeric field for calculating file sizes via an API endpoint and sets up a notification threshold list for monitoring purposes.

```json
{
  "type": "number",
  "id": "location_file_size",
  "appendProject": true,
  "disabled": true,
  "url": "/api/projectsetup/getSearchResult/",
  "protocol": "post",
  "search_settings": {
    "index": "files",
    "parameters": [
      {
        "entity_parameter": "unc_path",
        "target_parameter": "file_locations.unc_path"
      }
    ],
    "targetfield": "file_size",
    "action": "SUM"
  }
},
{
  "id": "notification_threshold",
  "type": "preconfigured_list",
  "values": ["5", "10", "15", "20", "25", "30", "35", "40"]
}
```
Tokens:
Raw