Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 5.57 KB

jobs.md

File metadata and controls

19 lines (15 loc) · 5.57 KB

<- home page

Jobs

Below you can see Logsearch-for-cloudfoundry jobs and their description.

Job Description Resources Deployment
ingestor_cloudfoundry-firehose This job provides firehose-to-syslog util.
It retrieves log events from the firehose feature in CloudFoundry and sends them to syslog.
spec

Packages:
firehose-to-syslog

Src:
firehose-to-syslog
Merged to ingestor job of Logsearch deployment.
parser-config-lfc This job compiles Logstash parsing rules and configs spec

Packages:
logsearch-config-logstash-filters

Src:
logsearch-config/src/logstash-filters
Merged to parser job of Logsearch deployment. Delivered via logstash_parser.filters and logstash_parser.deployment_dictionary properties.
elasticsearch-config-lfc This job compiles Elasticsearch index templates defining index mappings for Logsearch-for-cloudfoundry spec

Templates:
templates
Merged to maintenance job of Logsearch deployment. Delivered via elasticsearch_config.templates property.
upload-kibana-objects This job
1) Uploads predefined Kibana objects (provided by the job). Is controlled by kibana_objects.upload_predefined_kibana_objects property.
2) Uploads data files specified in property kibana_objects.upload_data_files.

Data is uploaded by executing ../_bulk query to Elasticsearch with passing Kibana saved objects json as --data-binary. Kibana objects are stored to .kibana index. Rewrites only those objects being uploaded.
spec

Run script:
run

Templates:
kibana-objects
This is an errand job.

Run as: bosh run errand upload-kibana-objects
cf-kibana (a) The job provides
1) cf-cli package (to interract with CloudFoundry)
2) Kibana package with installed authentication plugin, configs and scripts for deploying Kibana to CloudFoundry

The run script does the following:
* copies cf-kibana package and configs provided by the job
* installs Kibana plugins listed in cf-kibana.plugins property
* connects to CloudFoundry api (cloudfoundry.api_endpoint) using cf-cli
* creates org cf-kibana.cloudfoundry.system_org and space cf-kibana.cloudfoundry.logsearch_space for Kibana application
* creates new OAuth2 client if necessary for Kibana authentication plugin
* pushes Kibana application to CF
spec

Packages:
cf-cli
cf-kibana

Src:
kibana-cf_authentication

Run script:
errand.sh.erb
This is an errand job.

Run as: bosh run errand cf-kibana
create-uaa-client (b) Creates new OAuth2 client for Kibana authentication plugin. spec

Run script:
run
This is an errand job.

Run as: bosh run errand create-uaa-client
kibana-auth-plugin (b) The job is used to delivery Kibana authentication plugin when deploying Kibana as standalone instance.

The job provides Kibana authentication plugin archive.
spec

Packages:
kibana-auth-plugin

Src:
kibana-cf_authentication
Merged to kibana job of Logsearch deployment. Delivered via kibana.plugins property.
smoke-tests The job provides
1) cf-cli package (to interract with CloudFoundry)
2) golang package
3) smoke tests for Logsearch-for-cloudfoundry
spec

Packages:
cf-cli
golang
smoke-tests

Src:
logsearch-smoke-tests

Run script:
run.erb
This is an errand job.

Run as: bosh run errand smoke-tests

NOTE: Job (a) is used in case of installing Kibana as CloudFoundry application. Jobs (b) are used to add Kibana authentication when using standalone Kibana instance provided by Logsearch deployment.


<- prev page | next page ->