Hitachi

JP1 Version 13 JP1/Integrated Management 3 - Manager Configuration Guide

7.3.6 Newly installing JP1/IM - Agent with integrated agent host (for Windows)

Install the JP1/IM - Agent on the local disk of the primary server and the secondary server.

  1. Newly installing JP1/IM - Agent.

    For details on how to install the software, see 1.3.1(3) Procedure of JP1/IM - Agent installation.

    Select "Normal installation mode" for the installation mode.

    This command is executed for both the primary server and the secondary server.

    In the case of Windows, the installation destination folder must be the same path on the executable server and the standby server.

    Do not start the JP1/IM - Agent service on the physical host. If it is running, stop it.

  2. Create a folder for logical host on the shared disk.

    A folder created on a shared disk for logical host is called a shared folder. Create according to the following rules:

    • The path length of the shared disk is within 63 bytes.

    • The characters that can be used in the path of a shared disk are alphanumeric characters, spaces, hyphens, underscores, periods, path separators, and colons.

    • If you create more than one logical host, make sure that it does not overlap with other logical host shared folders.

  3. Create the contents of the shared folder.

    - Steps to be taken when physical host has not yet started operation

    1. Copy the folder below of physical host to the shared folder.

      Copy source

      Copy destination

      Agent-path/conf

      Shared-folder/jp1ima/

      Agent-path/bin

      Agent-path/data

      Agent-path/logs

      Agent-path/tmp

    2. Empty the contents of bin folder.

      Delete all files in the shared directory\jp1ima\bin folder.

      You must keep bin folder.

    3. Delete the definition file for physical host.

      Files in the shared-folder/jp1ima/conf with extensions other than ".model" and ".update" are definition file for physical host and therefore delete.

    - If you have already started operation on physical host

    1. Create the following directory in the shared folder.

      Go to the shared folder at the command prompt, and then execute the following command:

      mkdir jp1ima
mkdir jp1ima\conf
mkdir jp1ima\conf\secret
mkdir jp1ima\conf\user
mkdir jp1ima\conf\user\cert
mkdir jp1ima\conf\user\secret
mkdir jp1ima\conf\jpc_file_sd_config_off
mkdir jp1ima\bin
mkdir jp1ima\data
mkdir jp1ima\data\alertmanager
mkdir jp1ima\data\prometheus_server
mkdir jp1ima\data\fluentd
mkdir jp1ima\logs
mkdir jp1ima\logs\imagent
mkdir jp1ima\logs\imagentproxy
mkdir jp1ima\logs\imagentaction
mkdir jp1ima\logs\alertmanager
mkdir jp1ima\logs\prometheus_server
mkdir jp1ima\logs\windows_exporter
mkdir jp1ima\logs\blackbox_exporter
mkdir jp1ima\logs\ya_cloudwatch_exporter
mkdir jp1ima\logs\promitor_scraper
mkdir jp1ima\logs\promitor_resource_discovery
mkdir jp1ima\logs\script_exporter
mkdir jp1ima\logs\fluentd
mkdir jp1ima\logs\tools
mkdir jp1ima\tmp
mkdir jp1ima\tmp\upload
mkdir jp1ima\tmp\download
mkdir jp1ima\tmp\lockfiles

    2. Copy file to a shared folder.

      Copy file with the extensions ".model" and ".update" in Agent-path/conf of the primary server to the shared-folder/jp1ima/conf.

    3. Add initial secret.

      Add initial secret with the secret administration command. Here is the command line:

      jimasecret -add -key immgr.initial_secret -s "initial-secret" -l shared-folder

    4. Setup password of JP1/IM agent control base proxies.

      • If agent host connects to the manager host through a proxy that requires authentication, the proxy's authentication ID must setup password.

      • For setup of authentication ID of the proxy, see 1.21.2(2)(e) Setup the proxy authentication's authentication ID and Password (for Windows) (optional).Note that definition file is file under the shared folder.

      • Password of the proxy is setup with the secret administration command. Here is the command line:

        jimasecret -add -key immgr.proxy_user.authentication-ID -s "password-of-proxies" -l shared-folder

  4. Removes ".model" or ".update" from file name of the definition file.

    For all definition file that you copied to the shared-folder/jp1ima/conf, remove ".model" or ".update" that is granted to the end of file name.

  5. Configure TLS settings.

    When operating with TLS enabled, place the CA certificate file in the shared-folder\jp1ima\conf\user\cert.

    Also, enter the full path of the CA certificate in the immgr.tls_config.ca_file of the shared-folder\jp1ima\conf\jpc_imagentcommon.json.

  6. Modify the variables listed in definition file.

    Copy definition file in the shared-folder/jp1ima/conf contains the variable-names listed in the tables below. Search for each variable name and rewrite all corresponding parts as shown in the table below.

    Variable name

    Value to be rewritten

    @@immgr.host@@

    Replace with host name of the destination manager host.

    @@immgr.imbase_port@@

    Replace with port number of imbase process to connect to.

    @@immgr.imbaseproxy_port@@

    Replace with port number of imbase proxy process to connect to.

    @@immgr.proxy_url@@

    If you are connecting to Integrated manager host through a proxy, replace it with URL of the proxy.

    If not through a proxy, replace it with an empty string.

    @@immgr.proxy_user@@

    If the proxy requires authentication, replace it with user name of the proxy.

    Replace it with an empty string if it is not through a proxy or if it is not authentication.

    @@autostart@@

    Replace with "Manual".

    @@hostname@@

    Replace with logical host.

    @@installdir1@@

    Replace it with the path to the folder where you want to install the JP1/IM - Agent.

    @@installdir2@@

    Replace with the path of the shared folder.

  7. Change to IP binding method.

    Both physical host and logical host must be setup.

    For physical host, both nodes require setup. For physical host, restart of the service is required after changing setup.

    In physical host, physical host name is setup to the changes in the definition file as shown below.

    Service

    Target file

    Change point

    prometheus_server

    Agent-path\bin\jpc_prometheus_server_service.xml

    Specify the physical host name for --web.listen-address.

    --web.listen-address="host-name:port"

    alertmanager

    Agent-path\bin\jpc_alertmanager_service.xml

    Specify the physical host name for --web.listen-address.

    --web.listen-address="host-name:port"

    windows_exporter

    Agent-path\bin\jpc_windows_exporter_service.xml

    Specify the physical host name for --telemetry.addr.

    --telemetry.addr="host-name:port"

    blackbox_exporter

    Agent-path\bin\jpc_blackbox_exporter_service.xml

    Specify the physical host name for --web.listen-address.

    --web.listen-address="host-name:port"

    fluentd

    None

    Not applicable

    jpc_windows_exporter

    Service definition file located in Agent-path\bin

    Specify the IP address of the physical host for --telemetry.addr

    jpc_ya_cloudwatch_exporter

    Service definition file located in Agent-path\bin

    Specify the IP address of the physical host for -listen-address

    jpc_promitor_scraper

    Promitor Scraper runtime configuration file located in Agent-path\conf\promitor\scraper

    Specify the IP address of the physical host for resourceDiscovery.host

    jpc_promitor_resource_discovery

    None

    Not applicable

    jpc_script_exporter

    Service definition file located in Agent-path\bin

    Specify the IP address of the physical host for --web.listen-address

    jpc_fluentd(log metrics feature)

    Log metrics definition file located in Agent-path\conf\user

    Specify the IP address of the physical host for bind

    Also, "IP" is setup to the change point of definition file below.

    Service

    Target file

    Change point

    • imagent

    • imagentproxy

    Agent-path\conf\jpc_imagentcommon.json

    Specify "IP" in the JP1_BIND_ADDR.

    In logical host, logical host is named setup to the changes in definition file below.

    Service

    Target file

    Change point

    imagent

    Shared-folder\jp1ima\conf\jpc_imagent_service.xml

    Append the command line option -hostname to <arguments> as follows. 

    <arguments>-hostname logical hostname</arguments>

    imagentproxy

    Shared-folder\jp1ima\conf\jpc_imagentproxy_service.xml

    Append the command line option -hostname to <arguments> as follows. 

    <arguments>-hostname logical hostname</arguments>

    imagentaction

    Shared-folder\jp1ima\conf\jpc_imagentaction_service.xml

    Append the command line option -hostname to <arguments> as follows. 

    <arguments>-hostname logical hostname</arguments>

    prometheus_server

    Shared-folder\jp1ima\conf\jpc_prometheus_server_service.xml

    Specify the logical host name for --web.listen-address.

    --web.listen-address="host-name:port"

    alertmanager

    Shared-folder\jp1ima\conf\jpc_alertmanager_service.xml

    Specify the logical host name for --web.listen-address.

    --web.listen-address="host-name:port"

    windows_exporter

    Shared-folder\jp1ima\conf\jpc_windows_exporter_service.xml

    Specify the physical host name for --telemetry.addr.

    --telemetry.addr="host-name:port"

    blackbox_exporter

    Shared-folder\jp1ima\conf\jpc_blackbox_exporter_service.xml

    Specify the logical host name for --web.listen-address.

    --web.listen-address="host-name:port"

    fluentd

    None

    Not applicable

    jpc_windows_exporter

    Service definition file located in shared-folder\jp1ima\conf

    Specify the IP address of the logical host for --telemetry.addr

    jpc_ya_cloudwatch_exporter

    Service definition file located in shared-folder\jp1ima\conf

    Specify the IP address of the logical host for -listen-address

    jpc_promitor_scraper

    Promitor Scraper runtime configuration file located in shared-folder\jp1ima\conf\promitor\scraper

    Specify the IP address of the logical host for resourceDiscovery.host

    jpc_promitor_resource_discovery

    None

    Not applicable

    script_exporter

    Service definition file located in shared-folder\jp1ima\conf

    Specify the IP address of the logical host for --web.listen-address

    jpc_fluentd(log metrics feature)

    Log metrics definition file located in shared-folder\jp1ima\conf\user

    Specify the IP address of the logical host for bind

    Also, "IP" is setup to the change point of definition file below.

    Service

    Target file

    Change point

    • imagent

    • imagentproxy

    Shared-folder\jp1ima\conf\jpc_imagentcommon.json

    Specify "IP" in the JP1_BIND_ADDR.

    For promitor_scraper and promitor_resource_discovery, prepare new ports for the logical host and specify the portsas the value of the key in their definition file listed in the following table.

    Service

    Definition file

    Key to be modified

    Value

    promitor_scraper

    Promitor Scraper runtime configuration file located in shared-folder\jp1ima\conf\promitor\scraper

    server.httpPort

    Port number of promitor_scraper

    resourceDiscovery.port

    Port number of promitor_resource_discovery

    romitor discovery configuration file located in shared-folder\jp1ima\conf

    targets

    Port number of promitor_scraper

    promitor_resource_discovery

    Promitor Resource Discovery runtime configuration file located in shared-folder\jp1ima\conf\promitor\resource-discovery

    server.httpPort

    Port number of promitor_resource_discovery

  8. Add a logical host name to the service ID and display name in the service definition file.

    For all service definition files in the shared-folder\jp1ima\conf, assign logical host names to <id> and <name> described in the files.

    File name of the service definition file: jpc_service-name_service.xml

    Please implement this procedure for services that are not in use.

    Here is an example of an edit for jpc_alertmanager_service.xml

    Before change

    After change

    <id>jpc_alertmanager</id>

    <id>jpc_alertmanager_logical-host-name</id>

    <name>JPC Alertmanager</name>

    <name>JPC Alertmanager_ logical-host-name</name>

  9. Give logical host name to file name of service definition file.

    Give logical host name to file name of service definition file under the shared-folder/jp1ima/conf.

    File name before change:jpc_service-name_service.xml

    File name after change: jpc_service-name_service_logical-host-name.service.xml

    Please implement this procedure for services that are not in use.

    The following shows a sample jpc_alertmanager.service.xml.

    File name before change

    File name after change

    jpc_alertmanager_service.xml

    jpc_alertmanager_service_logical-host-name.xml

  10. Copy the service definition file to the destination folder.

    Copy service definition file (File renamed in step 8) in the shared-folder/jp1ima/conf to Agent-path\bin of both the primary server and the secondary server.

  11. Delete service definition file in the shared folder.

    Delete service definition file (Copy source file in step 9) at the bottom of the shared-folder/jp1ima/conf because it is not required.

  12. Generate a Windows servicing program for the logical host.

    On both the executable server and the standby server, copy the Windows serviced program in the Agent-path\bin to create a Windows serviced program for the logical host.

    Note that you copy the file name, not change it. Keep the source file as well.

    File name before change: jpc_service-name_service.exe

    File name after change: jpc_service-name_service_logical-host-name.exe

    Please implement this procedure for services that are not in use.

    The following shows a sample jpc_alertmanager_service.exe.

    File name before change

    File name after change

    jpc_alertmanager_service.exe

    jpc_alertmanager_service_logical-host-name.exe

  13. Register the service for the logical host with Windows.

    For the services used by logical host, both the primary server and the secondary server must register the services for logical host to Windows.

    For registration of logical host service, use the following command:

    Agent-path\tools\jpc_service -on service-key -h logical-host-name

    The following shows an example of registration servicing a Alertmanager.

    Agent-path\tools\jpc_service -on jpc_alertmanager -h logical-host-name

    Also, for services not used by logical hosts, move the following discovery configuration file from the shared-folder/jp1ima/conf folder to the shared-folder/jp1ima/conf/jpc_file_sd_config_off folder.

    Service

    Discovery configuration file

    prometheus_server

    None

    alertmanager

    None

    windows_exporter

    jpc_file_sd_config_windows.yml

    blackbox_exporter

    • jpc_file_sd_config_blackbox_http.yml

    • jpc_file_sd_config_blackbox_icmp.yml

    ya_cloudwatch_exporter

    jpc_file_sd_config_cloudwatch.yml

    fluentd

    None

    promitor

    jpc_file_sd_config_promitor.yml

    script_exporter

    None

  14. Verify that Windows has registered to servicing.

    On both the primary server and the secondary server, display the service of Windows to confirm that the service for logical host has been registered.

    The name of the service for the logical host is the name set in <name> in step 7.

  15. Perform the required setup.

    7.3.7 Setting up the JP1/IM - Agent during new installation (for Windows), 1.21.2 Settings of JP1/IM - Agent to make the required configuration changes.

  16. Reister the service for logical host in the cluster software.

    For JP1/IM - Agent service's registration to the clustered software, see 7.5 Registering into the cluster software during new installation and setup (for Windows).

    Also, register only the services you will use from listed in the following table, with your cluster software.

    Service name

    Dependency

    jpc_windows_exporter_service_logical-host-name

    • IP address resources

    • Physical disk resources

    jpc_cloudwatch_exporter_service_logical-host-name

    jpc_promitor_scraper_service_logical-host-name

    jpc_promitor_resource_discovery_service_logical-host-name

    jpc_script_exporter_service_logical-host-name

    jpc_fluentd_service_logical-host-name

    jpc_imagentaction_service_logical-host-name

  17. Setup JP1/IM - Agent to determine if it has stopped servicing for one minute on setup of the clusters.

    If you upload the definition file to integrated operation viewer, restart of the service might occur after you deploy the definition file.

    Also, if the content of the uploaded definition file is invalid and the service fails to start, the definition file is restored and the service is started.

    As described above, you should setup the clusters to prevent them from detecting a temporary service outage because service might be temporarily stopped.

  18. Check for problems in operation.

    • Start the service from the cluster software.

    • Causes a failover.

To Page Top

Copyright (C) 2023, 2024 Hitachi, Ltd.

Copyright (C) 2023, 2024 Hitachi Solutions, Ltd.