Performing the post deployment procedures


After the BMC Helix IT Operations Management deployment is complete, perform the following tasks:

  • Activate your BMC Helix IT Operations Management account. 
  • Import users or groups created by using an external identity provider (IdP).
  • Increase the log ingestion limit for your tenants if you are using BMC Helix Log Analytics.


To activate the BMC Helix IT Operations Management account

As a tenant administrator, perform the following steps:  

  1. Set the tenant administrator password:
    1. From the email that you received, click the activation link. 
      The activation link is valid for 72 hours.
    2. Log on to the product by using the tenant administrator user name and the product URL.
  2. On your product tile, click Launch to start using the product.


To set the ILM policy for log retention

If you enabled BMC Helix Logging, you must set the Index Lifecycle Management (ILM) policy for log retention in Kibana UI.

Important

The steps provided here are an example of setting the ILM policy to retain the logs for 10 days. You must make appropriate changes to the HelixLogDeletePolicy.json and helixlogindextemplate.json files to retain logs for a desired number of days.

To set up an ILM policy to retain the logs for 10 days, perform the following steps:

  1. To create an ILM policy, perform the following steps:
    1. Download the HelixLogDeletePolicy.jsonfile and copy its contents.

      To retain the logs for a desired number of days, open the HelixLogDeletePolicy.json file, under the delete section, change the value of the min_age parameter.

    2. Log in to the Kibana UI.
      From the config/infra.config file, obtain the URL to access the Kibana UI. 
      This is the value that you had set for the parameter KIBANA_LB_HOST.
      For example, https://kibana.apexglobal.bmc.com.
      See Configuration-file-settings.
    3. Click 23.4_ILM.png, and select Management > Dev Tools.
      23.4_ILM1.png
    4. If the Console tab has any data, delete it.
    5. Paste the contents of the HelixLogDeletePolicy.json file in the Console tab and click 23.4_ILM2.png

      23.4_ILM3A.png

      You will get the following message and a policy is created with the name HelixLogDelete10DaysLog-Policy:
      23.4_ILM_AclnowledgeTrue.png
  2. To apply the ILM policy to all indices that are already created, perform the following steps:
    1. Click 23.4_ILM.png, and select Management > Stack Management.
    2. Select Data > Index Management
    3. Select an index; for example, logstash-2024.01.04.
    4. From the Manage Index list, select Add lifecycle policy.
      23.4_ILM_IndexManagement2.png
    5. In the Add lifecycle policy to "<Index name>" box, from the Lifecycle policy list, select the policy that you created, and click Add policy.
      23.4_ILM-ManageIndex3.png
      The policy is applied only to the index that you had selected; for example, logstash-2024.01.04.
    6. Repeat the steps to apply the ILM policy to all indices.
  3. To verify that the policy is applied an index, perform the following steps:
    1. Click 23.4_ILM.png, and select Management > Stack Management.
    2. Select Data > Index Management
    3. Click an index to view the summary.
    4. In the Index lifecycle management area, click Show definition to verify that the policy is applied.
      23.4_ILM-ManageIndex4Confirmation1.png
  4. To create a ILM policy template, perform the following steps: 
    To apply the ILM policy to all new indices that might get created, you must create the ILM policy template. 
    1. Download the HelixLogIndexTemplate.jsonfile and copy its contents.

      In the HelixLogDeletePolicy.json file, if you changed the policy name, make sure to update the same policy name in the HelixLogIndexTemplate.json file. 

      In the HelixLogIndexTemplate.json file, the name of the template should always be in lowercase; for example, helixlogindextemplate.

    2. Click 23.4_ILM.pngand select Management > Devtools.
    3. In the Console tab, paste the contents of the HelixLogIndexTemplate.json file and click 23.4_ILM2.png
      You will get the following message:
      23.4_ILM_AclnowledgeTrue.png
      The index template HelixLogIndexTemplate gets created with the policy name HelixLogDelete10DaysLog-Policy.
      The new template will apply to all new indices. 
  5. To verify the ILM policy template created, perform the following steps:
    1. Click 23.4_ILM.png, and select Management > Stack Management.
    2. Select Data > Index Management
    3. Go to the Index Templates tab and verify that the template is created.
      23.4_ILM-FinalTemplateConfirmation.png

For more information, see ILM: Manage the index lifecycle.


To import users or groups created by using an external IdP

For instructions about importing users or groups created by using an external IdP into BMC Helix Portal, see the External IdP user access section in User identities.


(Optional) To update the SMTP details

If you want to change the SMTP details; for example, host, port, password, or username, perform the following steps:

  1. Update the SMTP ConfigMap:
    1. To edit the SMTP ConfigMap on a cluster, run the following command:

      kubectl edit cm smtp-credentials -n <mamespace>
    2. Update the required SMTP details; for example, SMTP_HOST or SMTP_PORT:

      apiVersion: v1
      data:
      SMTP_AUTH: "true"
      SMTP_HOST: mailhost.bmc.com
      SMTP_PORT: "25"
      kind: ConfigMap
    3. Save the file.

  2. Update the SMTP Secrets:
    1. To edit the SMTP secrets file, run the following command:

      kubectl edit secret smtp-credentials -n <namespace>

      The SMTP secrets file is displayed, as shown in the following code block:

      apiVersion: v1
      data:
      SMTP_PASSWORD: IiI=
      SMTP_USERNAME: BMC
      kind: Secret
    2. You can change the username, password, and other details in the secrets file. 
      To change the username or password, you must encode it into the Base64 format and then add it to the secrets file.
      • To encode the username in Base64 format, run the following command:

        echo -n <username> | base64

        Copy the encoded username that gets generated. 

      • To encode the password in Base64 format, run the following command:

        echo -n <password> | base64

        Copy the encoded password that gets generated. 

    1. Add the encoded username and password to the secrets file and save it.


(For BMC Helix Log Analytics) To change the log ingestion limit of your tenants

By default,  BMC Helix Log Analyticscan ingest a maximum of 1 GB logs on a tenant. As a tenant administrator, you can change the log ingestion limit by performing the following steps:

  1. From the controller box of your Kubernetes cluster, run the following command to get the name of the pod that runs the log-mgmt service:

    kubectl get pod -n <namespace> | grep log-mgmt-service
  2. Run the following command to increase the log ingestion limit:

    kubectl exec -it <log management pod name> -- bash -c "curl --location --request PUT 'http://log-mgmt-service:8093/logs-service/ingestion/control/api/v1.0/metadata/<tennant name>?idType=name' --header 'Content-Type: application/json' --data '{\"log_limit\" : <log ingestion limit>}'"

    For example, run the following command to increase the log limit to 2 GB:

    kubectl exec -it log-mgmt-service-67b7c65fdb-76nwc -- bash -c "curl --location --request PUT 'http://log-mgmt-service:8093/logs-service/ingestion/control/api/v1.0/metadata/acme?idType=name' --header 'Content-Type: application/json' --data '{\"log_limit\" : 2}'"

(For BMC Helix Log Analytics ) To disable log ingestion limit

Run the following command as a root user from a CLI service pod to disable the daily ingestion limit:

kubectl exec -it <cli-service pod> -- bash -c "./tcc confutil -s LogIngestionService -o edit -k enable.tenant.log.limit -v false"

For example,

kubectl exec -it cli-service-554489d6b4-69zk7 -- bash -c "./tcc confutil -s LogIngestionService -o edit -k enable.tenant.log.limit -v false"

Important

For any changes beyond the sizing category log limit, make sure that you make corresponding changes to the storage requirements.
For information about the sizing category log limit, see Sizing-and-scalability-considerations.

Where to go from here

For information about using the following products, see the appropriate documentation links:




 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*