diff options
| -rw-r--r-- | elasticstack/kibana/conf/README.md | 27 | ||||
| -rw-r--r-- | elasticstack/kibana/conf/kibana.properties | 56 | ||||
| -rw-r--r-- | elasticstack/kibana/conf/kibana.yml | 104 |
3 files changed, 187 insertions, 0 deletions
diff --git a/elasticstack/kibana/conf/README.md b/elasticstack/kibana/conf/README.md new file mode 100644 index 0000000..e04dd64 --- /dev/null +++ b/elasticstack/kibana/conf/README.md @@ -0,0 +1,27 @@ +#Kibana canonical configuration +------------------------------- +This kibana configuration is the deployment settings for kibana environment. + +#Files provided for kibana deployment +--------------------------------------- +# kibana.yml +# kibana.properties + +#Instructions for deployment +---------------------------- +1. Create canonical path /etc/onap/kibana/conf.d on the host on which the kibana has to be installed. +1. The kibana.yml is parameterized and has tokens instead of values for certain deployment specific parameters. These tokens has a syntax as '$[a-zA-Z_]+'. +3. These tokens are listed in another file kibana.properties. These properties are also provided with commented description about them in the file itself. These tokens have to be replaced with the appropriate values as per the deployment environment before deployment. +4. Now, save the final kibana.yml at location created in step 1. +5. Following is the list of specifications for kibana container creation- + + Image - 'docker.elastic.co/kibana/kibana:5.5.0' available in the Elastic Docker Registry. + + Port mapping - Default port published by kibana is 5601 + The container port 5601 should be published to host port 5601 + + Volume mapping - The kibana container must have one host paths mapped as volume in the container + Host path - /etc/onap/kibana/conf.d/kibana.yml mapped to + Container path - /usr/share/kibana/config/kibana.yml + +6. kibana.properties need not be deployed after the values from it are used. diff --git a/elasticstack/kibana/conf/kibana.properties b/elasticstack/kibana/conf/kibana.properties new file mode 100644 index 0000000..0b602a0 --- /dev/null +++ b/elasticstack/kibana/conf/kibana.properties @@ -0,0 +1,56 @@ +# 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" + +# The Kibana server's name. This is used for display purposes. +server_name: "Kibana" + +# The URL of the Elasticsearch instance to use for all your queries. +$elasticsearch_url: "http://localhost:9200" + +# When this setting's value is true Kibana uses the hostname specified in the server.host +# setting. When the value of this setting is false, Kibana uses the hostname of the host +# that connects to this Kibana instance. +#elasticsearch.preserveHost: true + +# 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: "elastic" +$elasticsearch_password: "changeme" + +# 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 validate that your Elasticsearch backend uses the same key files. +#$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 + +# Enables you 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 diff --git a/elasticstack/kibana/conf/kibana.yml b/elasticstack/kibana/conf/kibana.yml new file mode 100644 index 0000000..27a83a3 --- /dev/null +++ b/elasticstack/kibana/conf/kibana.yml @@ -0,0 +1,104 @@ +# 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. This only affects +# the URLs generated by Kibana, your proxy is expected to remove the basePath value before forwarding requests +# to Kibana. This setting cannot end in a slash. +#server.basePath: "" + +# 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 URL of the Elasticsearch instance to use for all your queries. +elasticsearch.url: $elasticsearch_url + +# When this setting's value is true Kibana uses the hostname specified in the server.host +# setting. When the value of this setting is false, Kibana uses the hostname of the host +# that connects to this Kibana instance. +#elasticsearch.preserveHost: true + +# 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: "discover" + +# 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: $elasticsearch_username +elasticsearch.password: $elasticsearch_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: $server_ssl_enabled +#server.ssl.certificate: $server_ssl_certificate +#server.ssl.key: $server_ssl_key + +# Optional settings that provide the paths to the PEM-format SSL certificate and key files. +# These files validate that your Elasticsearch backend uses the same key files. +#elasticsearch.ssl.certificate: $elasticsearch_ssl_certificate +#elasticsearch.ssl.key: $elasticsearch_ssl_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: $elasticsearch_ssl_certificateAuthorities + +# To disregard the validity of SSL certificates, change this setting's value to 'none'. +#elasticsearch.ssl.verificationMode: $elasticsearch_ssl_verificationMode + +# 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: 0 + +# Time in milliseconds to wait for Elasticsearch at Kibana startup before retrying. +#elasticsearch.startupTimeout: 5000 + +# Specifies the path where Kibana creates the process ID file. +#pid.file: /var/run/kibana.pid + +# Enables you 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 + +# The default locale. This locale can be used in certain circumstances to substitute any missing +# translations. +#i18n.defaultLocale: "en"
\ No newline at end of file |