In the previous article “How to automate Deploying Elastic Stack (1) and (2) using Ansible,” I described how to automate deploying a Webserver and Elasticsearch using Ansible, respectively. In today’s tutorial, I’ll show you how to install Kibana. If you haven’t finished the previous exercises, please do them first.
Deploy Kibana
As with the previous installation and deployment steps, we will create a role called Kibana:
$ pwd
/Users/liuxg/ansible/elasticsearch/roles
$ ansible-galaxy init kibana
- Role kibana was created successfully
Copy the codeIf you have never installed Kibana, please refer to my previous article “How to Install Kibana in an Elastic Stack on Linux, MacOS, and Windows” for a local installation. You can install Kibana in a local directory. The purpose of this installation is to copy its config/kibana.yml file. We will use this file as a template to personalize the deployed Kibana configuration. We copied the kibana. Yml file to the Kibana /template directory:
My original Kibana.yml file is as follows:
templates/kibana.yml
# Kibana is served by a back end server. This setting specifies the port to use. server.port: 5601 # Specifies the address to which the Kibana server will bind. IP addresses and host names are both valid values. # The default is 'localhost', which usually means remote machines will not be able to connect. # To allow connections from remote users, set this parameter to a non-loopback address. server.host: "0.0.0.0" # Enables you to specify a path to mount Kibana at if you are running behind a proxy `server.rewriteBasePath` setting to tell Kibana if it should remove the basePath # from requests it receives, and to prevent a deprecation warning at startup. # This setting cannot end in a slash. #server.basePath: "" # Specifies whether Kibana should rewrite requests that are prefixed with # `server.basePath` or require that they Are rewritten by your reverse proxy. # This setting was effectively always' false 'before Kibana 6.3 and will # default To 'true' starting in Kibana 7.0. #server. RewriteBasePath: false # The maximum payload size in bytes for incoming server requests. #server.maxPayloadBytes: 1048576 # The Kibana server's name. This is used for display purposes. server.name: "demo-kibana" # The URLs of the Elasticsearch instances to use for all your queries. elasticsearch.hosts: ["http://localhost:9200"] # Kibana uses an index in Elasticsearch to store saved searches, visualizations and # dashboards. Kibana creates a new index if the index doesn't already exist. #kibana.index: ".kibana" # The default application to load. #kibana.defaultAppId: "home" # If your Elasticsearch is protected with basic authentication, these settings provide # the username and password that the Kibana server uses to perform maintenance on the Kibana # index at startup. Your Kibana users still need to authenticate with Elasticsearch, which # is proxied through the Kibana server. elasticsearch.username: "kibana_system" elasticsearch.password: "password" # Enables SSL and paths to the PEM-format SSL certificate and SSL key files, respectively. # These settings enable SSL for outgoing requests from the Kibana server to the browser. #server.ssl.enabled: false #server.ssl.certificate: /path/to/your/server.crt #server.ssl.key: /path/to/your/server.key # Optional settings that provide the paths to the PEM-format SSL certificate and key files. # These files are used to verify the identity of Kibana to Elasticsearch and are required when # xpack.security.http.ssl.client_authentication in Elasticsearch is set to required. #elasticsearch.ssl.certificate: /path/to/your/client.crt #elasticsearch.ssl.key: /path/to/your/client.key # Optional setting that enables you to specify a path to the PEM file for the certificate # authority for your Elasticsearch instance. #elasticsearch.ssl.certificateAuthorities: [ "/path/to/your/CA.pem" ] # To disregard the validity of SSL certificates, change this setting's value to 'none'. #elasticsearch.ssl.verificationMode: full # Time in milliseconds to wait for Elasticsearch to respond to pings. Defaults to the value of # the elasticsearch.requestTimeout setting. #elasticsearch.pingTimeout: 1500 # Time in milliseconds to wait for responses from the back end or Elasticsearch. This value # must be a positive integer. #elasticsearch.requestTimeout: 30000 # List of Kibana client-side headers to send to Elasticsearch. To send *no* client-side # headers, set this value to [] (an empty list). #elasticsearch.requestHeadersWhitelist: [ authorization ] # Header names and values that are sent to Elasticsearch. Any custom headers cannot be overwritten # by client-side headers, regardless of the elasticsearch.requestHeadersWhitelist configuration. #elasticsearch.customHeaders: {} # Time in milliseconds for Elasticsearch to wait for responses from shards. Set to 0 to disable. #elasticsearch.shardTimeout: 30000 # Logs queries sent to Elasticsearch. Requires logging.verbose set to true. #elasticsearch.logQueries: false # Specifies the path where Kibana creates the process ID file. #pid.file: /var/run/kibana.pid # Enables you to specify a file where Kibana stores log output. #logging.dest: stdout # Set the value of this setting to true to suppress all logging output. #logging.silent: false # Set the value of this setting to true to suppress all logging output other than error messages. #logging.quiet: false # Set the value of this setting to true to log all events, including system usage information # and all requests. #logging.verbose: false # Set the interval in milliseconds to sample system and process performance # metrics. Minimum is 100ms. Defaults to 5000. #ops.interval: 5000 # Specifies locale to be used for all localizable strings, dates and number formats. # Supported languages are the following: English - en , by default , Chinese - zh-CN . #i18n.locale: "en"Copy the codeObviously, in the above configuration, a lot of values are fixed. We can select the items we need to configure and define them in defaults/main.yml:
With the variables defined above, we can modify our templates/main.yml as follows:
templates/main.yml
# Kibana is served by a back end server. This setting specifies the port to use. server.port: {{ server_port }} # Specifies the address to which the Kibana server will bind. IP addresses and host names are both valid values. # The default is 'localhost', which usually means remote machines will not be able to connect. # To allow connections from remote users, set this parameter to a non-loopback address. server.host: "{{ server_host }}" # Enables you to specify a path to mount Kibana at if you are running behind a proxy. # Use the `server.rewriteBasePath` setting to tell Kibana if it should remove the basePath # from requests it receives, and to prevent a deprecation warning at startup. # This setting cannot end in a slash. #server.basePath: "" # Specifies whether Kibana should rewrite requests that are prefixed with # `server.basePath` or require that they Are rewritten by your reverse proxy. # This setting was effectively always' false 'before Kibana 6.3 and will # default To 'true' starting in Kibana 7.0. #server. RewriteBasePath: false # The maximum payload size in bytes for incoming server requests. #server.maxPayloadBytes: 1048576 # The Kibana server's name. This is used for display purposes. server.name: "{{ server_name }}" # The URLs of the Elasticsearch instances to use for all your queries. elasticsearch.hosts: ["{{ elasticsearch_host }}"] # Kibana uses an index in Elasticsearch to store saved searches, visualizations and # dashboards. Kibana creates a new index if the index doesn't already exist. #kibana.index: ".kibana" # The default application to load. #kibana.defaultAppId: "home" # If your Elasticsearch is protected with basic authentication, these settings provide # the username and password that the Kibana server uses to perform maintenance on the Kibana # index at startup. Your Kibana users still need to authenticate with Elasticsearch, which # is proxied through the Kibana server. elasticsearch.username: "kibana_system" elasticsearch.password: "password" # Enables SSL and paths to the PEM-format SSL certificate and SSL key files, respectively. # These settings enable SSL for outgoing requests from the Kibana server to the browser. #server.ssl.enabled: false #server.ssl.certificate: /path/to/your/server.crt #server.ssl.key: /path/to/your/server.key # Optional settings that provide the paths to the PEM-format SSL certificate and key files. # These files are used to verify the identity of Kibana to Elasticsearch and are required when # xpack.security.http.ssl.client_authentication in Elasticsearch is set to required. #elasticsearch.ssl.certificate: /path/to/your/client.crt #elasticsearch.ssl.key: /path/to/your/client.key # Optional setting that enables you to specify a path to the PEM file for the certificate # authority for your Elasticsearch instance. #elasticsearch.ssl.certificateAuthorities: [ "/path/to/your/CA.pem" ] # To disregard the validity of SSL certificates, change this setting's value to 'none'. #elasticsearch.ssl.verificationMode: full # Time in milliseconds to wait for Elasticsearch to respond to pings. Defaults to the value of # the elasticsearch.requestTimeout setting. #elasticsearch.pingTimeout: 1500 # Time in milliseconds to wait for responses from the back end or Elasticsearch. This value # must be a positive integer. #elasticsearch.requestTimeout: 30000 # List of Kibana client-side headers to send to Elasticsearch. To send *no* client-side # headers, set this value to [] (an empty list). #elasticsearch.requestHeadersWhitelist: [ authorization ] # Header names and values that are sent to Elasticsearch. Any custom headers cannot be overwritten # by client-side headers, regardless of the elasticsearch.requestHeadersWhitelist configuration. #elasticsearch.customHeaders: {} # Time in milliseconds for Elasticsearch to wait for responses from shards. Set to 0 to disable. #elasticsearch.shardTimeout: 30000 # Logs queries sent to Elasticsearch. Requires logging.verbose set to true. #elasticsearch.logQueries: false # Specifies the path where Kibana creates the process ID file. #pid.file: /var/run/kibana.pid # Enables you to specify a file where Kibana stores log output. #logging.dest: stdout # Set the value of this setting to true to suppress all logging output. #logging.silent: false # Set the value of this setting to true to suppress all logging output other than error messages. #logging.quiet: false # Set the value of this setting to true to log all events, including system usage information # and all requests. #logging.verbose: false # Set the interval in milliseconds to sample system and process performance # metrics. Minimum is 100ms. Defaults to 5000. #ops.interval: 5000 # Specifies locale to be used for all localizable strings, dates and number formats. # Supported languages are the following: English - en , by default , Chinese - zh-CN . #i18n.locale: "en"Copy the codeNext, we create our task in Tasks /main.yml:
tasks/main.yml
---
# tasks file for kibana
# Installing Kibana
- name: Installing Kibana with apt
apt:
name: kibana
update_cache: yes
# Replacing default kibana.yml with updated file
- name: Replacing default kibana.yml with updated file
template:
src: kibana.yml
dest: /etc/kibana/kibana.yml
# Starting Kibana
- name: Starting Kibana
service:
name: kibana
state: started
enabled: yes
Copy the code
Next we modify the deploy-demo.yml file:
playbooks/deploy-demo.yml
--- # This playbook will deploy webserver - hosts: all become: yes roles: - .. /roles/add-elastic-repo # This playbook will deploy ELK stack - hosts: elk become: yes roles: - .. /roles/elasticsearch - .. /roles/kibanaCopy the code
We use the following command to deploy:
ansible-playbook -K -i inventory/hosts.yml playbooks/deploy-demo.yml
Copy the code$ pwd /Users/liuxg/ansible/elasticsearch $ ansible-playbook -K -i inventory/hosts.yml playbooks/deploy-demo.yml BECOME password: PLAY [all] ********************************************************************* TASK [Gathering Facts] * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * ok: [192.168.0.4] TASK [.. / roles/add - elastic - repo: Add ElasticSearch public signing key ******** OK: [192.168.0.4] TASK [../roles/ add-elastice-repo: Install apt - transport - HTTPS] * * * * * * * * * * * * * * * * * ok: [192.168.0.4] TASK [.. / roles/add - elastic - repo: Add ElasticSearch repo definitions] ********** OK: [192.168.0.4] TASK [../roles/add-elastic-repo: system update] ******************************* changed: [192.168.0.4] PLAY [elk] * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * TASK [Gathering Facts] * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * ok: [192.168.0.4] TASK [.. / roles/elasticsearch: Installing Elasticsearch] * * * * * * * * * * * * * * * * * * * * * * * ok: [192.168.0.4] TASK [.. / roles/Elasticsearch: Replace Default elasticSearch.yml] ************** OK: [192.168.0.4] TASK [../roles/ elasticSearch: The service] * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * ok: [192.168.0.4] TASK [.. / roles/kibana: Installing Kibana with apt] * * * * * * * * * * * * * * * * * * * * * * * * * * * * ok: [192.168.0.4] TASK [.. / roles/Kibana: Replacing Default Kibana. Yml with updated file] ******** changed: [192.168.0.4] TASK [../roles/ Kibana: Starting Kibana] *************************************** changed: [192.168.0.4] PLAY RECAP * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 192.168.0.4: ok=12 changed=3 unreachable=0 failed=0 skipped=0 rescued=0 ignored=0Copy the codeThe output above shows that our installation was successful. We typed the following address ubuntu:5601 into the MacOS browser.
It shows that our installation was successful. We can also go to the Ubuntu machine to view:
service kibana status
Copy the code
It shows that the Kibana service is running successfully.