{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"2"},"type":{"value":"flat"}},"macroMetadata":{"macroId":{"value":"97e6178a-7036-424d-9f27-520befdc4abd"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"fadb1373-5a65-4786-945b-abe22d2cb09f"}},{"type":"paragraph","content":[{"text":"Depending on the desired deployment scenario, there are a handful of different alternatives that can be approached for a particular customer installation. ","type":"text"}]},{"type":"paragraph","content":[{"text":"The Devo Endpoint Agent installation process is flexible to allow a number of deployment models by using a specific inventory file. In this document, the most common scenarios are depicted, as well as the list of additions to the inventory that are required to fulfill those. Thus, each subsection can be considered as an installation step that offers different alternatives for completion, and not a step-by-step installation procedure.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"If there is any special need not covered in this guideline, ","type":"text"},{"text":"contact Devo","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:support@devo.com"}}]},{"text":" for more detailed information.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"The inventory","type":"text"}]},{"type":"paragraph","content":[{"text":"The deployment of the Endpoint Agent is done via Ansible playbooks. The playbook instruments need steps to deploy the platform according to your needs, defining what and where you want to deploy every component. To do so, the Ansible playbooks use a YAML inventory file (","type":"text"},{"text":"How to build your inventory — Ansible Documentation","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html"}}]},{"text":") to understand what tasks are needed to accomplish this. The YAML inventory file is the core of the deployment and it is very important to have clear what type of deployment you want to achieve and to create a valid inventory file before starting the deployment process.","type":"text"}]},{"type":"paragraph","content":[{"text":"When preparing a new deployment of the Endpoint Agent, it is important to have in mind some questions:","type":"text"}]},{"type":"expand","attrs":{"title":"What type of deployment do you want?"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you are looking for a PoC or non-productive environment deployment, the standalone All-in-One deployment is provided, where the Ansible playbooks create two dockers with the ancillary services for the EA Manager to run properly.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you are looking for a small production environment and you do not need HA, you can use the standalone deployment, but use your own ancillary services (MySQL and REDIS) to give the system more robustness and security.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If you are looking for a bigger production deployment enabling HA, you should consider a distributed deployment using several managers and your own DB clusters to ensure robustness, security, and availability. Agents should communicate with the EA Manager via a Load Balancer to enable the use of more than one EA Manager.","type":"text"}]}]}]}]},{"type":"expand","attrs":{"title":"How are the agents going to connect to the EA Manager?"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The endpoints connect to the manager via ","type":"text"},{"text":"/etc/hosts","type":"text","marks":[{"type":"code"}]},{"text":" change.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The endpoints connect to the manager with a known FQDN.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The endpoints connect to the manager using a public IP but no FQDN.","type":"text"}]}]}]}]},{"type":"expand","attrs":{"title":"What data do you want to collect? "},"content":[{"type":"paragraph","content":[{"text":"Check the packs provided out of the box in ","type":"text"},{"text":"Preintegrated query packs","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/v7100/pages/94636060"}}]},{"text":". ","type":"text"}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"The Endpoint Agent provides several YAML templates to base your inventory file in, depending on the case that you are trying to deploy. An Ansible YAML inventory file is composed of three main sections:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"fe0d410a-4d4a-41bd-adaf-7253506d2348"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[385.0]},"content":[{"type":"paragraph","content":[{"text":"all -> vars","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"This section defines all the variables that are going to be used in the tasks during the playbook run.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[385.0]},"content":[{"type":"paragraph","content":[{"text":"all -> hosts","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"This section defines the information related to the hosts where the solution is going to be deployed. It can include one or more hosts, and it is composed of blocks named after the hostname of the destination host.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[385.0]},"content":[{"type":"paragraph","content":[{"text":"all -> children","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[375.0]},"content":[{"type":"paragraph","content":[{"text":"This section defines the topology that is going to be deployed. You can define host groups with a specific name and include the hosts defined in the ","type":"text"},{"text":"all->hosts","type":"text","marks":[{"type":"code"}]},{"text":" section. The playbook will then deploy specific roles to those groups when it's run.","type":"text"}]},{"type":"paragraph","content":[{"text":"The pre-defined host groups are the following:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"devoeamanagerserverone","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"mandatory","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - First EA Manager server.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"devoeamanagerreplicas","type":"text","marks":[{"type":"code"}]},{"text":" - Secondary (or more) manager servers. This role needs to include a variable ","type":"text"},{"text":"deam_am_i_replica: true","type":"text","marks":[{"type":"code"}]},{"text":" in this section.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deamintsrvs","type":"text","marks":[{"type":"code"}]},{"text":" - EA Manager required ancillary services that should be enabled only in one host. If this role is included, it creates a docker for MySQL and Redis . If you will be using your own databases, this host group should not be included in the inventory.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deaagentpackager","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"mandatory","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - EA repository that can be enabled in one or more hosts. In each host included in this group, playbook packages osquery installers with certificates and secrets, and generates the auto-installation scripts for the agents that will be deployed in the endpoints. It also installs and configures am NGINX service to easily download said packages.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"selfsigenedcertificates","type":"text","marks":[{"type":"code"}]},{"text":" / ","type":"text"},{"text":"providedcertificates","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"mandatory","type":"text","marks":[{"type":"subsup","attrs":{"type":"sup"}},{"type":"textColor","attrs":{"color":"#ff5630"}}]},{"text":" - Only one of these hosts groups can be enabled at the same time and are only required just as in devoeamanagerserverone:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"selfsigenedcertificates","type":"text","marks":[{"type":"code"}]},{"text":" - Instruct the EA deployer to generate self-signed certificates that will be used to secure the communication between the endpoints and the manager. By default, the self-signed certificates created by the EA deployer will only trust the FQDN defined in deam_fqdn. In the case you need your certificate to trust different names (for example, to use a public IP and not the FQDN) , you can use the variable SAN_extensions and define a list of Subject Alternative Names (IPs and DNSs) to be included in the certificate (valid format and values: ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://docs.ansible.com/ansible/2.9/modules/openssl_csr_module.html#parameter-subject_alt_name"}},{"text":").","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"providedcertificates","type":"text","marks":[{"type":"code"}]},{"text":" - Instruct the EA deployer to use existing certificates instead of creating new ones. You should use this group if you want to use your own certificates for EA Manager.","type":"text"}]}]}]}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Standalone deployment template","type":"text"}]},{"type":"paragraph","content":[{"text":"The below snippet is a valid inventory file for a standalone deployment.","type":"text"}]},{"type":"codeBlock","content":[{"text":"all:\n vars:\n deam_fqdnname: << FQDN >>\n dea_ap_builder_update_etc_host: << yes/no >>\n dea_ap_overwrite_deam_fqdnname: << PUBLIC_HOST_IP >> \n set_deam_fqdnname_as_hostname: false\n deam_admin_username: << ADMIN_USER >>\n deam_admin_passwd: << ADMIN_PASS >>\n dea_ap_repo_user: << REPO_USER >>\n dea_ap_repo_passwd: << REPO_PASS >>\n deam_redis_address: << REDIS_ADDRESS:PORT >>\n deam_mysql_address: << MYSQL_ADDRESS:PORT >>\n deam_relay_entrypoint: << ENTRYPOINT_URL >>\n deam_packs_enabled:\n - configuration.yaml\n - events.yaml\n - fetchfiles.yaml\n - performance.yaml\n - status.yaml\n hosts:\n << HOST_NAME >>:\n ansible_host: << HOST_IP >>\n ansible_user: << HOST_USER >>\n ansible_ssh_pass: << HOST_PASS >>\n # Only required if you connect with password\n ansible_ssh_common_args: '-o StrictHostKeyChecking=no'\n ansible_python_interpreter: << PYTHON_INTERPRETER >>\n children:\n devoeamanagerserverone:\n hosts:\n << HOST_NAME >>:\n deamintsrvs:\n hosts:\n << HOST_NAME >>:\n deaagentpackager:\n hosts:\n << HOST_NAME >>:\n selfsigenedcertificates: # Alternative providedcertificates\n hosts:\n << HOST_NAME >>:\n vars:\n #If no Subject Alternate Names are required, completely remove the SAN_extensions block.\n SAN_extensions:\n - IP: << HOST_PUBLIC_IP >>\n - DNS: << HOST_FQDN >>\n - DNS: << HOST_FQDN_2 >>","type":"text"}]},{"type":"paragraph","content":[{"text":"Check the descriptions of the parameters below:","type":"text"}]},{"type":"expand","attrs":{"title":"all→vars"},"content":[{"type":"table","attrs":{"layout":"default","localId":"6577e38b-c171-418e-9d5b-f3cf7dd894d6"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_fqdnname","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"FQDN of the EA Manager. Agents will use this FQDN to communicate to the EA Manager.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"dea_ap_builder_update_etc_host","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Indicates if the installation package of the endpoints will update ","type":"text"},{"text":"/etc/hosts","type":"text","marks":[{"type":"code"}]},{"text":" to communicate with the manager.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the FQDN set in deam_fqdnname is public and the agents can reach it, set it as “no”.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the FQDN set in deam_fqdnname is not reachable by the agents and the communication with the EA Manager is via internet, set it as “no”. Configure the parameter ","type":"text"},{"text":"dea_ap_overwrite_deam_fqdnname","type":"text","marks":[{"type":"code"}]},{"text":" with the public IP so that the agents will use it to communicate.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the FQDN set in deam_fqdnname is not reachable by the agents and the communication with the EA Manager is via private network, set it as “yes”. When an agent is deployed, the ","type":"text"},{"text":"/etc/hosts","type":"text","marks":[{"type":"code"}]},{"text":" will be modified to assign the IP configured in ansible_host to the FQDN value.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"dea_ap_overwrite_deam_fqdnname","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"If the FQDN is not reachable by the agent, but the manager need to be accessed via the internet, put here the public IP that the agent will use to connect. When using public FQDNs or local connection using ","type":"text"},{"text":"/etc/hosts","type":"text","marks":[{"type":"code"}]},{"text":" this parameter is not necessary and can be removed completely from the inventory.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"set_deam_fqdnname_as_hostname","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"This parameter can always be kept as false. It is a legacy parameter that will be deprecated in the future.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_admin_username","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"User for the WEB interface of the EA Manager.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_admin_passwd","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Password for the WEB interface of the EA Manager.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"dea_ap_repo_user","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"User for the agent download repository.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"dea_ap_repo_passwd","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Password for the agent download repository.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_redis_address","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"REDIS address and port:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the deployment is self creating dockers for REDIS and MySQL, the value should be configured as ","type":"text"},{"text":"localhost:6379","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the deployment is using your own DB services, the value should be configured with the address of the REDIS database and the port of access. ","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_mysql_address","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"MySQL address and port:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the deployment is self creating dockers for REDIS and MySQL, the value should be configured as ","type":"text"},{"text":"localhost:3306","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the deployment is using your own DB services, the value should be configured with the address of the MySQL database and the port of access. ","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_relay_entrypoint","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Includes the entry point value of the Devo collector for your deployment:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If your domain is deployed in the US Cloud (","type":"text"},{"text":"us.devo.com","type":"text","marks":[{"type":"link","attrs":{"href":"http://us.devo.com"}}]},{"text":"): ","type":"text"},{"text":"tcp://us.elb.relay.logtrust.net:443","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If your domain is deployed in the EU Cloud (","type":"text"},{"text":"eu.devo.com","type":"text","marks":[{"type":"link","attrs":{"href":"http://eu.devo.com"}}]},{"text":"): ","type":"text"},{"text":"tcp://eu.elb.relay.logtrust.net:443","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If your domain is deployed in a different cloud, contact your Devo representative to know your entry point.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_packs_enabled","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"List of YAML files including the definition of the packs that will be deployed into the EA Manager. ","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"all→hosts"},"content":[{"type":"table","attrs":{"layout":"default","localId":"b5383f2e-9668-4e6d-afe3-8f31629586db"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"hosts","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The hosts section of the inventory is composed by a group of hosts named with the hostname of the host. In the case of standalone deployment it will include only one. Replace ","type":"text"},{"text":"<< HOST_NAME >>","type":"text","marks":[{"type":"code"}]},{"text":" with the hostname of the server where the installation is happening. Ansible will connect via SSH to every host where it needs to take action using the data configured in this section.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"ansible_host","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"IP of the EA Manager server that ansible is going to use to connect to the host. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"ansible_user","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"SSH User to connect to this host","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"ansible_ssh_pass","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Password for the SSH user. It is not mandatory to use a password when using the playbooks. If you want to use SSH keys, just comment out this parameter and add your ssh key at Linux session level or include it in this section using the parameter ","type":"text"},{"text":"ansible_ssh_private_key_file","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"ansible_python_interpreter","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Specify what python interpreter will be used depending on your Linux distribution and version:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Python 2 - ","type":"text"},{"text":"/usr/bin/python2","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Python 3 - ","type":"text"},{"text":"/usr/bin/python3","type":"text","marks":[{"type":"code"}]}]}]}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Distributed deployment template","type":"text"}]},{"type":"paragraph","content":[{"text":"The following template is a deployment of Endpoint Agent with two EA Managers using existing databases. This deployment also requires a Load Balancer to be placed between the endpoints and the two EA Managers.","type":"text"}]},{"type":"codeBlock","content":[{"text":"all:\n vars:\n deam_fqdnname: << FQDN >>\n dea_ap_builder_update_etc_host: << yes/no >>\n set_deam_fqdnname_as_hostname: false\n deam_admin_username: << ADMIN_USER >>\n deam_admin_passwd: << ADMIN_PASS >>\n dea_ap_repo_user: << REPO_USER >>\n dea_ap_repo_passwd: << REPO_PASS >>\n deam_redis_address: << REDIS_ADDRESS:PORT >>\n deam_redis_password: << REDIS_PASSWORD >>\n deam_mysql_address: << MYSQL_ADDRESS:PORT >> \n deam_mysql_database: << MYSQL_DATABASE_NAME >>\n deam_mysql_username: << MYSQL_USER >>\n deam_mysql_password: << MYSQL_PASSWORD >>\n deam_relay_entrypoint: << ENTRYPOINT_URL >>\n deam_packs_enabled:\n - configuration.yaml\n - events.yaml\n - fetchfiles.yaml\n - performance.yaml\n - status.yaml\n hosts:\n << HOST_NAME_SERVER_1 >>:\n ansible_host: << HOST_IP >>\n ansible_user: << HOST_USER >>\n ansible_ssh_pass: << HOST_PASS >>\n # Only required if you connect with password\n ansible_ssh_common_args: '-o StrictHostKeyChecking=no'\n ansible_python_interpreter: << PYTHON_INTERPRETER >>\n << HOST_NAME_SERVER_2 >>:\n # Set ansible_host your public ip used to conncet from ansbile and devo-ea agents\n ansible_host: << HOST_IP >>\n ansible_user: << HOST_USER >>\n ansible_ssh_pass: << HOST_PASS >>\n # Only required if you connect with password\n ansible_ssh_common_args: '-o StrictHostKeyChecking=no'\n # python3 required for Ubuntu 18 ansible-playbooks\n ansible_python_interpreter: << PYTHON_INTERPRETER >>\n children:\n devoeamanagerserverone:\n hosts:\n << HOST_NAME_SERVER_1 >>:\n devoeamanagerreplicas:\n hosts:\n << HOST_NAME_SERVER_2 >>:\n vars:\n deam_am_i_replica: true \n deamintsrvs:\n hosts:\n << HOST_NAME_SERVER_1 >>:\n deaagentpackager:\n hosts:\n << HOST_NAME_SERVER_1 >>:\n << HOST_NAME_SERVER_2 >>:\n selfsigenedcertificates: # Alternative providedcertificates\n hosts:\n << HOST_NAME_SERVER_1 >>:","type":"text"}]},{"type":"paragraph","content":[{"text":"Check the descriptions of the parameters below:","type":"text"}]},{"type":"expand","attrs":{"title":"all→vars"},"content":[{"type":"table","attrs":{"layout":"default","localId":"3a44e265-2edb-408e-90d8-a0525cb386a5"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_fqdnname","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"FQDN of the Load Balancer. Agents will use this FQDN to communicate to the EA Manager.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"dea_ap_builder_update_etc_host","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Indicates if the installation package of the endpoints will update ","type":"text"},{"text":"/etc/hosts","type":"text","marks":[{"type":"code"}]},{"text":" to communicate with the Load Balancer.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the FQDN set in ","type":"text"},{"text":"deam_fqdnname","type":"text","marks":[{"type":"code"}]},{"text":" is public and the agents can reach it, set it as ","type":"text"},{"text":"no","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the FQDN set in ","type":"text"},{"text":"deam_fqdnname","type":"text","marks":[{"type":"code"}]},{"text":" is not reachable by the agents and the communication with the EA Manager is via internet, set it as ","type":"text"},{"text":"no","type":"text","marks":[{"type":"code"}]},{"text":". Configure the parameter ","type":"text"},{"text":"dea_ap_overwrite_deam_fqdnname","type":"text","marks":[{"type":"code"}]},{"text":" with the public IP so that the agents will use it to communicate.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If the FQDN set in ","type":"text"},{"text":"deam_fqdnname","type":"text","marks":[{"type":"code"}]},{"text":" is not reachable by the agents and the communication with the EA Manager is via private network, set it as ","type":"text"},{"text":"yes","type":"text","marks":[{"type":"code"}]},{"text":". When an agent is deployed, the ","type":"text"},{"text":"/etc/hosts","type":"text","marks":[{"type":"code"}]},{"text":" will be modified to assign the IP configured in ","type":"text"},{"text":"ansible_host","type":"text","marks":[{"type":"code"}]},{"text":" to the FQDN value.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"dea_ap_overwrite_deam_fqdnname","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"If the FQDN is not reachable by the agent, but the manager need to be accessed via the internet, put here the public IP that the agent will use to connect. When using public FQDNs or local connection using ","type":"text"},{"text":"/etc/hosts","type":"text","marks":[{"type":"code"}]},{"text":" this parameter is not necessary and can be removed completely from the inventory.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"set_deam_fqdnname_as_hostname","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"This parameter can always be kept as ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":". It is a legacy parameter that will be deprecated in the future.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_admin_username","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"User for the WEB interface of the EA Manager.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_admin_passwd","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Password for the WEB interface of the EA Manager.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"dea_ap_repo_user","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"User for the agent download repository.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"dea_ap_repo_passwd","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Password for the agent download repository.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_redis_address","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"REDIS address and port.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_redis_passwd","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"REDIS password.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_mysql_address","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"MySQL address and port.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_mysql_database","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Name of the database to be used by EA Manager. The database should have been created in advance. Check the ","type":"text"},{"text":"Using existing databases","type":"text","marks":[{"type":"link","attrs":{"href":"#databases"}}]},{"text":" section.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_mysql_username","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Username to access the database.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_mysql_password","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Password to access the database.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_relay_entrypoint","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Includes the entry point value of the Devo collector for your deployment:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If your domain is deployed in the US Cloud (","type":"text"},{"text":"us.devo.com","type":"text","marks":[{"type":"link","attrs":{"href":"http://us.devo.com"}}]},{"text":"): ","type":"text"},{"text":"tcp://us.elb.relay.logtrust.net:443","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If your domain is deployed in the EU Cloud (","type":"text"},{"text":"eu.devo.com","type":"text","marks":[{"type":"link","attrs":{"href":"http://eu.devo.com"}}]},{"text":"): ","type":"text"},{"text":"tcp://eu.elb.relay.logtrust.net:443","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If your domain is deployed in a different cloud, contact your Devo representative to know your entry point.","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"deam_packs_enabled","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"List of YAML files including the definition of the packs that will be deployed into the EA Manager. ","type":"text"}]}]}]}]}]},{"type":"expand","attrs":{"title":"all→hosts"},"content":[{"type":"table","attrs":{"layout":"default","localId":"42221d7e-a47e-4405-b80e-3591d7c03705"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"hosts","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The hosts section of the inventory is composed by a group of hosts named with the hostname of the host. In the case of standalone deployment it will include only one. Replace ","type":"text"},{"text":"<< HOST_NAME >>","type":"text","marks":[{"type":"code"}]},{"text":" with the hostname of the server where the installation is happening. Ansible will connect via SSH to every host where it needs to take action using the data configured in this section.","type":"text"}]},{"type":"paragraph","content":[{"text":"For each host, configure the following parameters.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"ansible_host","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"IP of the EA Manager server that ansible is going to use to connect to the host. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"ansible_user","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"SSH User to connect to this host","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"ansible_ssh_pass","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Password for the SSH user. It is not mandatory to use a password when using the playbooks. If you want to use SSH keys, just comment out this parameter and add your ssh key at Linux session level or include it in this section using the parameter ","type":"text"},{"text":"ansible_ssh_private_key_file","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"ansible_python_interpreter","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Specify what python interpreter will be used depending on your Linux distribution and version:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Python 2 - ","type":"text"},{"text":"/usr/bin/python2","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Python 3 - ","type":"text"},{"text":"/usr/bin/python3","type":"text","marks":[{"type":"code"}]}]}]}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Deployment credentials","type":"text"}]},{"type":"paragraph","content":[{"text":"The Devo EA Deployer uses SSH to connect to the different servers where it needs to install different components. When configuring the hosts in the inventory file, it is necessary to configure the SSH user and authentication method that the deployer needs to use in each task.","type":"text"}]},{"type":"expand","attrs":{"title":"Using SSH user and password"},"content":[{"type":"paragraph","content":[{"text":"For a user and password-based authentication method, the configuration for the host should look like the one in the following snippet:","type":"text"}]},{"type":"codeBlock","content":[{"text":"all:\n ...\n hosts:\n devo-ea-manager:\n ansible_host: 192.168.57.5\n ansible_user: ssh_user\n ansible_ssh_pass: ssh_pass\n ansible_ssh_common_args: '-o StrictHostKeyChecking=no'\n ...","type":"text"}]}]},{"type":"expand","attrs":{"title":"Using SSH private key"},"content":[{"type":"paragraph","content":[{"text":"Alternatively, use the following code in order to use a private key:","type":"text"}]},{"type":"codeBlock","content":[{"text":"all:\n ...\n hosts:\n devo-ea-manager:\n ansible_host: 192.168.57.5\n ansible_user: ssh_user\n ansible_ssh_private_key_file: << PATH TO YOUR SSH KEY HERE >>\n ...","type":"text"}]},{"type":"paragraph","content":[{"text":"Adding the path to the private key in the inventory file is not mandatory. It can be added to the environment using ","type":"text"},{"text":"ssh-add 'key file'","type":"text","marks":[{"type":"code"}]},{"text":" instead of adding it to the inventory file.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Initial packs configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"From v1.1.0 onwards, the Endpoint Agent deployer enables customers to decide which query packs are deployed with the solution, as opposed to all of them being added automatically during the installation process. Therefore, the installer must decide which packs to add to the baseline configuration to fulfill the customer’s particular needs and use cases. The complete list of available packs, along with a description of their functionality and set of supported use cases, can be found in the ","type":"text"},{"text":"preintegrated query packs","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/v7100/pages/94636060"}}]},{"text":" section.","type":"text"}]},{"type":"paragraph","content":[{"text":"The process to enable packs is handled with two parameters in the inventory file:","type":"text"}]},{"type":"table","attrs":{"layout":"default","isNumberColumnEnabled":true,"localId":"3e37da0c-0e92-4ebd-8b28-8edb1b0bc2e8"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.0]},"content":[{"type":"paragraph","content":[{"text":"deam_packs_enabled","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.0]},"content":[{"type":"paragraph","content":[{"text":"Sets what packs to be deployed when running both ","type":"text"},{"text":"devo-endpoint-agent","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"deam-packs","type":"text","marks":[{"type":"code"}]},{"text":" playbooks. ","type":"text"}]},{"type":"paragraph","content":[{"text":"In the following example, only the configuration (represented by ","type":"text"},{"text":"configuration.yaml","type":"text","marks":[{"type":"code"}]},{"text":") and events (","type":"text"},{"text":"events.yaml","type":"text","marks":[{"type":"code"}]},{"text":") packs are deployed:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":50.0},"content":[{"type":"media","attrs":{"width":942,"id":"cf6d72b8-149d-4795-96d4-a73f74a13609","collection":"contentId-94636114","type":"file","height":450}}]},{"type":"paragraph","content":[{"text":"The file names included in this list come from the files placed in ","type":"text"},{"text":"$HOME/devo-ea-deployer/playbooks/roles/deam-packs/files/optional-devo-packs","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.0]},"content":[{"type":"paragraph","content":[{"text":"deam_packs_purge_cached_files","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.0]},"content":[{"type":"paragraph","content":[{"text":"Use this option when you do not want to deploy a pack anymore. Once the packs are deployed for the first time, they are cached under (","type":"text"},{"text":"/var/devo-ea-manager/packs/devo-packs","type":"text","marks":[{"type":"code"}]},{"text":"). If you want to avoid some of the packages being redeployed, make sure to include them in the purge list before triggering the deploy operation. Otherwise, the deployer will use the cached version and deploy the packs again even if they are not included in ","type":"text"},{"text":"deam_packs_enabled","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"In the following example, the installation user is deploying only the ","type":"text"},{"text":"configuration.yaml","type":"text","marks":[{"type":"code"}]},{"text":" pack and is purging the ","type":"text"},{"text":"events.yaml","type":"text","marks":[{"type":"code"}]},{"text":" pack that was previously deployed from the temporary folder:","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":50.0},"content":[{"type":"media","attrs":{"width":970,"id":"fafe69bc-c042-4811-92ef-288d3d15d43f","collection":"contentId-94636114","type":"file","height":484}}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Python Interpreter","type":"text"}]},{"type":"paragraph","content":[{"text":"When deploying in CentOS 7 or Red Hat 7 OS, make sure that the host is configured to use python 2 instead of python 3 in the inventory file.","type":"text"}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-ui-tabs-macro","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"1876a3e2-a5b3-4fd6-a1e5-0dcb7b0c1d9b"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tabs.png"}}],"title":"UI Tabs"}},"localId":"f25b5b55-4841-4ccf-9817-d588174ca545"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-tab","parameters":{"macroParams":{"title":{"value":"Hosts in Centos7 or RedHat 7"}},"macroMetadata":{"macroId":{"value":"fbf3282de01a237d1ffa331dc3da2dfc"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tab.png"}}],"title":"UI Tab"}},"localId":"ba08e57e-6732-4791-a649-418935a0e748"}},{"type":"codeBlock","content":[{"text":"all:\n ...\n hosts:\n devo-ea-manager:\n ...\n ansible_python_interpreter: /usr/bin/python2","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-tab","parameters":{"macroParams":{"title":{"value":"Other OS"}},"macroMetadata":{"macroId":{"value":"314c30e59da764e5d139d6ebc8733501"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tab.png"}}],"title":"UI Tab"}},"localId":"04cfe23a-0679-465a-851c-8eabf2cfb642"}},{"type":"codeBlock","content":[{"text":"all:\n ...\n hosts:\n devo-ea-manager:\n ...\n ansible_python_interpreter: /usr/bin/python3","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Endpoint Agent <> EA Manager communication","type":"text"}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-ui-tabs-macro","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"efa46935-8213-452b-a9a6-502c0e9a3104"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tabs.png"}}],"title":"UI Tabs"}},"localId":"3000c313-88dd-4375-94f4-cc1bddb9bbb3"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-tab","parameters":{"macroParams":{"title":{"value":"Using FQDN"}},"macroMetadata":{"macroId":{"value":"c411593be9d4f25d36ca9aa6a58bafae"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tab.png"}}],"title":"UI Tab"}},"localId":"11ce17a2-f1bd-4d42-b1d8-df11a1152b3d"}},{"type":"paragraph","content":[{"text":"In the event that the EA Manager is going to be available on an open Internet environment, or the administrator does not want to rely on explicitly setting each endpoint in the hosts file to ease further IP updates, there is the possibility to configure the deployer to use an FQDN (Fully Qualified Domain Name). To do so, add a code section such as in the following example to the inventory file, adding only the fields that are not already included:","type":"text"}]},{"type":"codeBlock","content":[{"text":"all\n vars:\n deam_fqdnname: itops-devo-ea-public-pre-1902513970.eu-west-1.elb.amazonaws.com\n set_deam_fqdnname_as_hostname: false\n dea_ap_builder_update_etc_host: \"no\"","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_fqdnname","type":"text","marks":[{"type":"code"}]},{"text":": FQDN of the Devo EA Manager or the Load Balancer FQDN in the case of multiple EA Managers. Endpoints will use this FQDN to connect to the Devo EA Manager.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"set_deam_fqdn_as_hostname","type":"text","marks":[{"type":"code"}]},{"text":": Set to ","type":"text"},{"text":"false","type":"text","marks":[{"type":"em"}]},{"text":" to avoid changing the EA Manager hostname to the value set in the above field.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dea_ap_builder_update_etc_host","type":"text","marks":[{"type":"code"}]},{"text":": Set to ","type":"text"},{"text":"no","type":"text","marks":[{"type":"em"}]},{"text":" to instruct the endpoint installers to not modify the endpoint ","type":"text"},{"text":"hosts","type":"text","marks":[{"type":"code"}]},{"text":" file.","type":"text"}]}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-tab","parameters":{"macroParams":{"title":{"value":"Using hosts file"}},"macroMetadata":{"macroId":{"value":"536edef211c1bcfa07be0dd43e0bc216"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tab.png"}}],"title":"UI Tab"}},"localId":"c9d41be5-6fc9-4d48-917d-62a1116203ef"}},{"type":"paragraph","content":[{"text":"This is the most common deployment scenario, where all the endpoints will connect to the UA Manager via a modification in the ","type":"text"},{"text":"/etc/hosts","type":"text","marks":[{"type":"code"}]},{"text":" file. This is the default case, and there is no specific configuration change needed to use it. ","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"EA Manager <> Devo communication","type":"text"}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-ui-tabs-macro","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"7bffdd1c-e96d-43d6-b44c-920b91b4cd30"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tabs.png"}}],"title":"UI Tabs"}},"localId":"d4beeca0-df8d-464f-abbf-945820633769"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-tab","parameters":{"macroParams":{"title":{"value":"Direct connectivity"}},"macroMetadata":{"macroId":{"value":"4a52c313f28ce6c9fef18bcd4a76fb37"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tab.png"}}],"title":"UI Tab"}},"localId":"27a49b69-d48f-4e46-8cb7-3b3107a736a6"}},{"type":"paragraph","content":[{"text":"This is the default scenario, where the EA Manager has direct connectivity to Devo. In this case, there is no need for any specific configuration as the installer should work as is.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-tab","parameters":{"macroParams":{"title":{"value":"Using a Devo Relay"}},"macroMetadata":{"macroId":{"value":"a6fe51757905aea199e4bc5e39bb54a7"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://d1bgdtsfe1sjdg.cloudfront.net/refinedtheme-for-cloud/macro-icons/tab.png"}}],"title":"UI Tab"}},"localId":"bca508d9-20bf-4caf-a7e9-4854f50dc058"}},{"type":"paragraph","content":[{"text":"In some cases, we may want to use a Devo Relay to centralize all ingested traffic for a particular deployment such as to enforce an extra level of security or isolation of the EA Manager.","type":"text"}]},{"type":"paragraph","content":[{"text":"Assuming that the Devo Relay IP is 192.168.43.147, we just need to configure ","type":"text"},{"text":"deam_relay_entrypoint: tcp://192.168.43.147:13000","type":"text","marks":[{"type":"code"}]},{"text":". We chose port number 13000 port because the relay service is configured to listen in that port by default.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example snippet of inventory file based on that configuration:","type":"text"}]},{"type":"codeBlock","content":[{"text":"all:\n vars:\n ...\n deam_relay_entrypoint: tcp://192.168.43.147:13000\n deam_devo_key: \"\"\n deam_devo_cert: \"\"\n deam_devo_chain: \"\"","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Other special deployment cases","type":"text"}]},{"type":"expand","attrs":{"title":"Using a proxy during the installation"},"content":[{"type":"paragraph","content":[{"text":"The Devo EA installation process is not standalone and requires Internet access for the installation to be successful. If the server does not have Internet access and requires a proxy to be able to communicate to the external world, please use the following configurations:","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Please note that these configurations are outside of the EA Manager product. The following instructions are provided as recommendations to the customer and may have high variability depending on the system and specific scenario.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Depending on the system being deployed, append the following two lines in the corresponding file depending on the Linux distribution the EA Manager will be installed on:","type":"text"}]},{"type":"codeBlock","content":[{"text":"export http_proxy=http://:\nexport https_proxy=http://:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If using ","type":"text"},{"text":"root","type":"text","marks":[{"type":"code"}]},{"text":" user in Ubuntu distribution:","type":"text"},{"text":" /etc/bash.bashrc","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If using ","type":"text"},{"text":"root","type":"text","marks":[{"type":"code"}]},{"text":" user in Centos distribution:","type":"text"},{"text":" /etc/bashrc","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If using a ","type":"text"},{"text":"sudoer","type":"text","marks":[{"type":"code"}]},{"text":" in Ubuntu or Centos distribution: ","type":"text"},{"text":"~/.bashrc","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"paragraph","content":[{"text":"Create ","type":"text"},{"text":"dir ~/.ssh","type":"text","marks":[{"type":"code"}]},{"text":" and file ","type":"text"},{"text":"~/.ssh/environment","type":"text","marks":[{"type":"code"}]},{"text":" if they do not exist and append the following lines to the file ","type":"text"},{"text":"~/.ssh/environment","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"http_proxy=http://:\nhttps_proxy=http://:","type":"text"}]},{"type":"paragraph","content":[{"text":"Append the following line to the file ","type":"text"},{"text":"/etc/sudoers","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"Defaults env_keep = \"http_proxy https_proxy\"","type":"text"}]},{"type":"paragraph","content":[{"text":"Append the following line to the file ","type":"text"},{"text":"/etc/ssh/sshd_config","type":"text","marks":[{"type":"code"}]},{"text":":","type":"text"}]},{"type":"codeBlock","content":[{"text":"PermitUserEnvironment=yes","type":"text"}]},{"type":"paragraph","content":[{"text":"Reload the ssh service: ","type":"text"},{"text":"sudo systemctl reload sshd","type":"text","marks":[{"type":"code"}]}]}]},{"type":"expand","attrs":{"title":"Deployment in a server with no outbound traffic allowed"},"content":[{"type":"paragraph","content":[{"text":"In some cases, the Devo EA Manager may need to be deployed on a server with a very limited outbound Internet connectivity. The following list is a compilation of outbound domains that would need to be specifically opened in the firewall so the Devo EA Deployer can be executed properly:","type":"text"}]},{"type":"table","attrs":{"layout":"full-width","localId":"d24403ef-0e63-40f5-b444-b457bde1a5a6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"Domain/URL","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"Purpose","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"*.devo.com","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"Connectivity toward Devo","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"*.logtrust.net","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"Connectivity toward Devo","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"https://pkg.osquery.io/","type":"text","marks":[{"type":"link","attrs":{"href":"https://pkg.osquery.io/"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"Used to download the upstream sw of the agents, osquery","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"https://d2ur64jmn3k7yt.cloudfront.net/","type":"text","marks":[{"type":"link","attrs":{"href":"https://d2ur64jmn3k7yt.cloudfront.net/"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"Belongs to Devo, where the deployer will download manager and extensions binaries","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"*.fedoraproject.org","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"For RH repos","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"*.centos.org","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"For CentOS repos","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"https://nginx.org","type":"text","marks":[{"type":"link","attrs":{"href":"https://nginx.org"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"For NGINX repo","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"http://pypi.python.org/","type":"text","marks":[{"type":"link","attrs":{"href":"http://pypi.python.org/"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":" The Python package index","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"http://galaxy.ansible.com/","type":"text","marks":[{"type":"link","attrs":{"href":"http://galaxy.ansible.com/"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"Directory for ansible galaxy","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"https://github.com/geerlingguy/ansible-role-pip/archive/2.0.0.tar.gz","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/geerlingguy/ansible-role-pip/archive/2.0.0.tar.gz"}}]}]},{"type":"paragraph","content":[{"text":"https://github.com/geerlingguy/ansible-role-docker/archive/3.0.0.tar.gz","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/geerlingguy/ansible-role-docker/archive/3.0.0.tar.gz"}}]}]},{"type":"paragraph","content":[{"text":"https://github.com/nginxinc/ansible-role-nginx/archive/0.19.1.tar.gz","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/nginxinc/ansible-role-nginx/archive/0.19.1.tar.gz"}}]}]},{"type":"paragraph","content":[{"text":"https://github.com/nginxinc/ansible-role-nginx-config/archive/0.3.3.tar.gz","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/nginxinc/ansible-role-nginx-config/archive/0.3.3.tar.gz"}}]}]},{"type":"paragraph","content":[{"text":"https://github.com/geerlingguy/ansible-role-repo-epel/archive/3.0.0.tar.gz","type":"text","marks":[{"type":"link","attrs":{"href":"https://github.com/geerlingguy/ansible-role-repo-epel/archive/3.0.0.tar.gz"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[899.0]},"content":[{"type":"paragraph","content":[{"text":"Ansible roles","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"High availability configuration","type":"text"}]},{"type":"paragraph","content":[{"text":"Some deployment scenarios will require the deployment of more than one EA Manager to cater to all the traffic generated from the endpoints, and to ensure that high availability of the data processing and forwarding is observed. In this case, a specific configuration during the installation process is required to instruct the Devo EA Deployer how to instantiate those roles.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Devo EA Deployer will take care of deploying several EA Managers, but in order to provide a single entry point to the endpoints, it is necessary to set up a Load Balancer separately.","type":"text"}]}]},{"type":"expand","attrs":{"title":"Load balancer requirements"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Load Balancers should have two HTTPs listeners, in port 8080 and in port 8081, as there will be two different services. TCP listeners are not supported by the Devo EA Manager.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Load Balancers should present the same certificate to the endpoints as the EA Manager. When using self-signed certificates created automatically by the deployer, the certificate can be found in ","type":"text"},{"text":"/etc/devo-ea-manager/certs","type":"text","marks":[{"type":"code"}]},{"text":" after the installation process is completed.","type":"text"}]}]}]}]},{"type":"expand","attrs":{"title":"Inventory file configuration"},"content":[{"type":"paragraph","content":[{"text":"To add a secondary Devo EA Manager, add a new host in the all.hosts section and instruct that the EA Manager role should be installed on it in the children section. See the following code snippet as an example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"all:\n ...\n hosts:\n devo-ea-manager:\n ansible_host: 10.0.0.10\n ansible_user: install_user\n ansible_python_interpreter: /usr/bin/python2\n devo-ea-manager-2:\n ansible_host: 10.0.0.11\n ansible_user: install_user\n ansible_python_interpreter: /usr/bin/python2\n children:\n devoeamanagerserverone:\n hosts:\n devo-ea-manager:\n devoeamanagerreplicas:\n hosts:\n devo-ea-manager-2:\n vars:\n duem_am_i_replica: true\n...","type":"text"}]},{"type":"paragraph","content":[{"text":"In the above example, two hosts are declared (","type":"text"},{"text":"devo-ea-manager","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"devo-ea-manager-2","type":"text","marks":[{"type":"code"}]},{"text":") in the hosts section. In the children section, the Deployer is instructed to install the EA Manager in ","type":"text"},{"text":"devo-ea-manager","type":"text","marks":[{"type":"code"}]},{"text":" and a replica in ","type":"text"},{"text":"devo-ea-manager-2","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"expand","attrs":{"title":"Agent download service replication"},"content":[{"type":"paragraph","content":[{"text":"To enable the secondary manager to also provide the Agents' download service in port 8081, it is necessary to explicitly instruct the Deployer to enable that option in the inventory file. See the following code snippet as an example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"all\n ...\n children:\n ...\n deaagentpackager:\n hosts:\n devo-ea-manager:\n devo-ea-manager-2:\n vars:\n devo_ea_manager_port: 443\n ...","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Databases installation","type":"text"}]},{"type":"paragraph","content":[{"text":"The EAM relies on MySQL and Redis for data (configurations, etc.) persistence. There are several scenarios to consider depending on the type of installation required for a particular customer.","type":"text"}]},{"type":"paragraph","content":[{"text":"The next section summarizes the most common alternatives for the deployment of the databases, as well as the procedure to implement them.","type":"text"}]},{"type":"expand","attrs":{"title":"Using Deployer DB self-deployment"},"content":[{"type":"paragraph","content":[{"text":"The Deployer can install a dockerized version of MySQL and Redis both in the same server than the EA Manager runs or in a different server.","type":"text"}]},{"type":"paragraph","content":[{"text":"The parameters that need to be configured for both databases are the following:","type":"text"}]},{"type":"codeBlock","content":[{"text":"deam_redis_address: 10.0.0.24:6379\ndeam_redis_password: password\ndeam_mysql_address: 10.0.0.60:3306\ndeam_mysql_database: databasename\ndeam_mysql_username: user\ndeam_mysql_password: password","type":"text"}]},{"type":"paragraph","content":[{"text":"Mandatory parameters:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_redis_address","type":"text","marks":[{"type":"code"}]},{"text":" - IP and port of the server that will host Redis.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_mysql_address","type":"text","marks":[{"type":"code"}]},{"text":" - IP and port of the server that will host MySQL.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Optional parameters (if the following parameters are not included in the inventory file, the default value is used): ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_redis_password","type":"text","marks":[{"type":"code"}]},{"text":" - Password of the Redis instance, if it exists. In case Redis does not use a password, set the value as ","type":"text"},{"text":"\"\". Default value: \"\"","type":"text","marks":[{"type":"em"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_mysql_database","type":"text","marks":[{"type":"code"}]},{"text":" - Name of the database to be used. Default value: ","type":"text"},{"text":"kolide","type":"text","marks":[{"type":"em"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_mysql_username","type":"text","marks":[{"type":"code"}]},{"text":" - Name of the user to access the database. Default value: ","type":"text"},{"text":"kolide","type":"text","marks":[{"type":"em"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_mysql_password","type":"text","marks":[{"type":"code"}]},{"text":" - Password of the user to access the database. Default value: ","type":"text"},{"text":"kolide","type":"text","marks":[{"type":"em"}]}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Standalone deployment","type":"text"}]},{"type":"paragraph","content":[{"text":"If the database dockers are going to be installed in the same server as the UA Manager, the role ","type":"text"},{"text":"deamintsrvs","type":"text","marks":[{"type":"code"}]},{"text":" must be configured to be deployed to the ","type":"text"},{"text":"devo-ea-manager","type":"text","marks":[{"type":"code"}]},{"text":" host. ","type":"text"}]},{"type":"codeBlock","content":[{"text":" all:\n ...\n children:\n ... \n deamintsrvs:\n hosts:\n devo-ea-manager: ","type":"text"}]},{"type":"paragraph","content":[{"text":"This snippet indicates that the role ","type":"text"},{"text":"deamintsrvs","type":"text","marks":[{"type":"code"}]},{"text":" (MySQL and Redis) will be deployed in the host ","type":"text"},{"text":"devo-ea-manager","type":"text","marks":[{"type":"code"}]},{"text":" which is defined as well in the inventory file. Check the example configuration files to get some ideas on what your inventory file should look like.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Distributed deployment","type":"text"}]},{"type":"paragraph","content":[{"text":"If the databases are going to be installed on a different server than the EA Manager, the role ","type":"text"},{"text":"deamintsrvs","type":"text","marks":[{"type":"code"}]},{"text":" should be configured to be deployed to a different host: ","type":"text"}]},{"type":"codeBlock","content":[{"text":"all:\n ...\n hosts:\n devo-ea-manager:\n ...\n deam-int-services:\n ansible_host: 10.0.10.10\n ansible_user: ubuntu\n ansible_ssh_private_key_file: /path/to/private.key.pem\n ansible_python_interpreter: /usr/bin/python3\n children:\n ...\n deamintsrvs:\n hosts:\n deam-int-services:","type":"text"}]},{"type":"paragraph","content":[{"text":"In the example above, a new host named ","type":"text"},{"text":"deam-int-services","type":"text","marks":[{"type":"code"}]},{"text":" is defined and the Deployer is instructed to install the database services on it. The host information is included inside the ","type":"text"},{"text":"all.hosts","type":"text","marks":[{"type":"code"}]},{"text":" tag, so the deployer will know where and how to connect to the new server.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"In distributed deployments it is important to make sure all necessary configurations to enable visibility between services—between the EAM and the databases, for example—is done beforehand (enabling traffic through the designated ports in any intermediary firewalls).","type":"text"}]}]}]},{"type":"expand","attrs":{"title":"Using existing databases"},"content":[{"type":"paragraph","content":[{"text":"Devo Endpoint Agent Deployer allows the option of using existing deployments of MySQL and Redis. This solution should be the one to be observed to enable full HA scenarios.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Prepare the MySQL database","type":"text"}]},{"type":"paragraph","content":[{"text":"When using an existing MySQL database, it is necessary to manually create the database structures and the credentials that the EA Manager will use to interact with it.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Access the MySQL instance with root credentials (or create database privilege granted):","type":"text"}]},{"type":"codeBlock","content":[{"text":"mysql -uuser -ppasword","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create the database to be used by EA Manager (the database name can be changed, deamDB is just an example):","type":"text"}]},{"type":"codeBlock","content":[{"text":"CREATE DATABASE deamDB;","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Grant ALL PRIVILEGES over the database to the user that DEAM will use (both username and password can be changed, the following is just an example):","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"GRANT ALL PRIVILEGES ON deamDB.* TO 'deamUser'@'%' IDENTIFIED BY 'deamPassword';","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Prepare the Redis database","type":"text"}]},{"type":"paragraph","content":[{"text":"No specific configurations in Redis are required other than having full accessibility to the database and valid credentials (password) to access it.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Prepare the EA Deployer","type":"text"}]},{"type":"paragraph","content":[{"text":"The parameters that control the DB deployment in Devo EA Deployer are the following:","type":"text"}]},{"type":"codeBlock","content":[{"text":"deam_redis_address: 10.0.0.24:6379\ndeam_redis_password: password\ndeam_mysql_address: 10.0.0.60:3306\ndeam_mysql_database: databasename\ndeam_mysql_username: user\ndeam_mysql_password: password","type":"text"}]},{"type":"paragraph","content":[{"text":"Mandatory parameters:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_redis_address","type":"text","marks":[{"type":"code"}]},{"text":" - VIP and port of Redis instance/cluster.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_mysql_address","type":"text","marks":[{"type":"code"}]},{"text":" - VIP and port of MySQL instance/cluster.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_redis_password","type":"text","marks":[{"type":"code"}]},{"text":" - Password of the Redis instance, if it exists. In case Redis use no password, input ““.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_mysql_database","type":"text","marks":[{"type":"code"}]},{"text":" - Name of the database to be used.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_mysql_username","type":"text","marks":[{"type":"code"}]},{"text":" - Name of the user to access the database.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deam_mysql_password","type":"text","marks":[{"type":"code"}]},{"text":" - Password of the user to access the database.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"When an existing database is used, make sure to remove the ","type":"text"},{"text":"deamintsrvs","type":"text","marks":[{"type":"code"}]},{"text":" from the installation plan in the inventory file. This will instruct the deployer to not deploy any database automatically. If a snippet like the following exists in the inventory file inside ","type":"text"},{"text":"all.children","type":"text","marks":[{"type":"code"}]},{"text":" tag, remove it:","type":"text"}]},{"type":"codeBlock","content":[{"text":"deamintsrvs:\n hosts:\n devo-ea-manager:","type":"text"}]},{"type":"paragraph"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Devo EA Manager users and passwords","type":"text"}]},{"type":"paragraph","content":[{"text":"After a successful deployment of Devo EA Manager, two services that require authentication will be created. User and password can be configured to include your own passwords. If these parameters are not included in the inventory file, default values are used.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Devo EA Manager Web Interface (port 8080): To control the user and password for this service, the following parameters can be used in the inventory file:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"#deam_admin_username: _Devo EA manager_ username for initial admin user setup. Default value: `admin`\ndeam_admin_username: admin\n#deam_admin_passwd: _Devo EA manager_ password for initial admin user setup. Default value: `Th3Adm1n!`\nduam_admin_passwd: Th3Adm1n!","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Devo Endpoint Agent download (port 8081): To control the user and password for this service, the following parameters can be used in the inventory file:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"#dea_ap_repo_user: Username required by _Devo EA packager_ repository for basic authentication. Default value `dea-agent`\ndea_ap_repo_user: dea-agent\n#dea_ap_repo_passwd: Password required by _Devo EA packager_ repository for basic authentication. Default value `Th3Ag3nt!`\ndea_ap_repo_passwd: Th3Ag3nt!","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Certificates","type":"text"}]},{"type":"paragraph","content":[{"text":"The Devo EA Deployer is configured to generate self-signed certificates and configure them by default but you can configure EA Deployer to use your own certificates.","type":"text"}]},{"type":"paragraph","content":[{"text":"It is recommended to use ECDSA certificates instead of RSA as TLS decryption in the EA Manager side is smoother and increases the performance significantly. The EA Deployer will generate ECDSA certificates by default when using self-generated certificates.","type":"text"}]},{"type":"expand","attrs":{"title":"Using self-signed certificates"},"content":[{"type":"paragraph","content":[{"text":"The Devo EA Deployer is configured to generate self-signed certificates and configure them by default.","type":"text"}]}]},{"type":"expand","attrs":{"title":"Using your own certificates"},"content":[{"type":"paragraph","content":[{"text":"You can provide your own key or certificate when you run deploy EA Manager using Devo EA Deployer. ","type":"text"}]},{"type":"paragraph","content":[{"text":"To do this, replace the ","type":"text"},{"text":"selfsigenedcertificates","type":"text","marks":[{"type":"code"}]},{"text":" section with ","type":"text"},{"text":"providedcertificates","type":"text","marks":[{"type":"code"}]},{"text":" in the inventory file (at same yaml level). ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Only one of these sections can be present in the inventory file.","type":"text"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Inventory file with self-signed certificates generation:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"selfsigenedcertificates: # Alternative providedcertificates\n hosts:\n devo-ea-manager:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Inventory file with provided certificates:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":" providedcertificates:\n hosts:\n devo-ea-manager:","type":"text"}]},{"type":"paragraph","content":[{"text":"Save your ","type":"text"},{"text":"devo-ea-manager.key","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"devo-ea-manager.crt","type":"text","marks":[{"type":"code"}]},{"text":" files in ","type":"text"},{"text":"devo-ea-deployer/provided-deam-certs","type":"text","marks":[{"type":"code"}]},{"text":" path. Provided certs must match with the entry point used by DEA agents to connect with EA Manager.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Example inventory files","type":"text"}]},{"type":"expand","attrs":{"title":"Full high-availability installation example"},"content":[{"type":"paragraph","content":[{"text":"The following code shows a deployment inventory file that enables the installation of two Devo EA Managers, with customized usernames and passwords, and leveraging on an existing MySQL and Redis deployment ( customer-provided). Endpoints connectivity is enabled via FQDN:","type":"text"}]},{"type":"codeBlock","content":[{"text":"all:\nvars:\n#deam_fqdnname: Put the Load Balancer FQDN here. This FQDN will be used by the endpoints to reach the EA Manager\ndeam_fqdnname: loadbalancer_fqdn.com\nset_deam_fqdnname_as_hostname: false\ndea_ap_builder_update_etc_host: \"no\"\n#deam_redis_address: Input here the VIP and port for the Redis cluster\ndeam_redis_address: 10.0.0.24:6379\n#deam_redis_password: Redis service password. If there is no password, input \"\"\ndeam_redis_password: password\n#deam_mysql_address: Input here the VIP and port for the MySQL cluster\ndeam_mysql_address: 10.0.0.60:3306\n#deam_mysql_database: Input here the database name\ndeam_mysql_database: databasename\n#deam_mysql_username: MySQL user name. User must have enough permissions to create schema, tables, views, etc.\ndeam_mysql_username: user\n#deam_mysql_password: MySQL password\ndeam_mysql_password: password\ndeam_relay_entrypoint: tcp://us.elb.relay.logtrust.net:443\n#deam_admin_username: _Devo EA manager_ username for initial admin user setup. Default value: `admin`\ndeam_admin_username: admin\n#deam_admin_passwd: _Devo EA manager_ password for initial admin user setup. Default value: `Th3Adm1n!`\ndeam_admin_passwd: Th3Adm1n!\n#dea_ap_repo_user: Username required by _Devo EA packager_ repository for basic authentication. Default value `dea-agent`\ndea_ap_repo_user: dea-agent\n#dea_ap_repo_passwd: Password required by _Devo EA packager_ repository for basic authentication. Default value `Th3Ag3nt!`\ndea_ap_repo_passwd: Th3Ag3nt!\n\nhosts:\n#ansible_host: Input IP for Devo EA Manager 1. Can be private, the IP from where the deployer is going to SSH the server for installation tasks.\n#ansible_user: SSH user to perform installation tasks\n#Depending on the type of SSH user used for the instalation, uncomment the proper lines in each host and fill a value:\n#ansible_ssh_pass: Password for the SSH user\n#ansible_ssh_private_key_file: Private key path to the used PEM file if not using password\n# Only required if you connect with password\n#ansible_ssh_common_args: '-o StrictHostKeyChecking=no'\ndevo-ea-manager:\nansible_host: 10.0.0.10\nansible_user: install_user\n#ansible_ssh_pass:\n#ansible_ssh_common_args: '-o StrictHostKeyChecking=no'\n#ansible_ssh_private_key_file:\nansible_python_interpreter: /usr/bin/python2\ndevo-ea-manager-2:\nansible_host: 10.0.0.11\nansible_user: install_user\n#ansible_ssh_pass:\n#ansible_ssh_common_args: '-o StrictHostKeyChecking=no'\n#ansible_ssh_private_key_file:\nansible_python_interpreter: /usr/bin/python2\nchildren:\ndevoeamanagerserverone:\nhosts:\ndevo-ea-manager:\ndevoeamanagerreplicas:\nhosts:\ndevo-ea-manager-2:\nvars:\ndeam_am_i_replica: true\ndevoeaagents:\nhosts:\ndeaagentpackager:\nhosts:\ndevo-ea-manager:\ndevo-ea-manager-2:\nvars:\ndevo_ea_manager_port: 443\nselfsigenedcertificates: # Alternative providedcertificates\nhosts:\ndevo-ea-manager:","type":"text"}]}]},{"type":"expand","attrs":{"title":"Standalone installation example"},"content":[{"type":"paragraph","content":[{"text":"The following code shows a deployment inventory file that enables an AIO (All In One) deployment. Everything is automatically deployed in the same server, including two dockers running the database services. Endpoint connectivity is enabled via the ","type":"text"},{"text":"hosts","type":"text","marks":[{"type":"code"}]},{"text":" file.","type":"text"}]},{"type":"codeBlock","content":[{"text":"all:\nvars:\ndeam_fqdnname: devo-ea-manager\ndeam_redis_address: localhost:6379\ndeam_mysql_address: localhost:3306\ndeam_relay_entrypoint: tcp://us.elb.relay.logtrust.net:443\nhosts:\ndevo-ea-manager:\n# Set ansible_host your public ip used to conncet from ansbile and devo-ea agents\nansible_host: 192.168.57.5\nansible_user: user\nansible_ssh_pass: pass\n# Only required if you connect with password\nansible_ssh_common_args: '-o StrictHostKeyChecking=no'\n# python3 required for Ubuntu 18 ansible-playbooks\nansible_python_interpreter: /usr/bin/python3\nchildren:\ndevoeamanagerserverone:\nhosts:\ndevo-ea-manager:\ndeamintsrvs:\nhosts:\ndevo-ea-manager:\ndeaagentpackager:\nhosts:\ndevo-ea-manager:\nselfsigenedcertificates: # Alternative providedcertificates\nhosts:\ndevo-ea-manager:\ndevoeaagents:\nhosts:","type":"text"}]}]},{"type":"paragraph"}],"version":1}