Table of Contents - consul-templaterb-1.32.1 Documentation
Pages
-
CHANGELOG
- CHANGELOG
- 1.31.1 (Jan 28, 2021)
- 1.32.0 (Jan 27, 2021)
- 1.31.1 (Jan 25, 2021)
- 1.31.0 (Jan 18, 2021)
- 1.30.0 (Dec 18, 2020)
- 1.29.0 (Oct 6, 2020)
- 1.28.2 (Oct 5, 2020)
- 1.28.1 (Sept 30, 2020)
- 1.28.0 (Sept 25, 2020)
- 1.27.2 (Sept 4, 2020)
- 1.27.1 (July 28, 2020)
- 1.27.0 (June 5, 2020)
- 1.26.3 (April 15, 2020)
- 1.26.2 (April 15, 2020)
- 1.26.1 (March 27, 2020)
- 1.26.0 (March 5, 2020)
- 1.25.2 (February 29, 2020)
- 1.25.1 (February 28, 2020)
- 1.25.0 (February 27, 2020)
- 1.24.1 (February 19, 2020)
- 1.24.0 (February 19, 2020)
- 1.23.0 (February 18, 2020)
- 1.22.0 (January 17, 2020)
- 1.21.8 (January 2, 2020)
- 1.21.7 (December 16, 2019)
- 1.21.6 (December 16, 2019)
- 1.21.5 (December 6, 2019)
- 1.21.4 (November 28, 2019)
- 1.21.3 (November 23, 2019)
- 1.21.2 (November 22, 2019)
- 1.21.1 (November 22, 2019)
- 1.21.0 (November 21, 2019)
- 1.20.0 (October 16, 2019)
- 1.19.0 (October 14, 2019)
- 1.18.5 (September 30, 2019)
- 1.18.4 (September 19, 2019)
- 1.18.3 (September 2, 2019)
- 1.18.2 (August 28, 2019)
- 1.18.1 (July 27, 2019)
- 1.18.0 (July 27, 2019)
- 1.17.3 (July 18, 2019)
- 1.17.3 (July 18, 2019)
- 1.17.2 (July 17, 2019)
- 1.17.1 (July 15, 2019)
- 1.17.0 (July 15, 2019)
- 1.16.0 (July 8, 2019)
- 1.15.3 (June 20, 2019)
- 1.15.2 (June 12, 2019)
- 1.15.1 (May 23, 2019)
- 1.15.0 (May 14, 2019)
- 1.14.1 (May 13, 2019)
- 1.14.0 (May 6, 2019)
- 1.13.1 (April 12, 2019)
- 1.13.0 (April 10, 2019)
- 1.12.0 (April 4, 2019)
- 1.11.0 (March 16, 2019)
- 1.10.1 (February 28, 2019)
- 1.10.0 (February 27, 2019)
- 1.9.9 (January 18, 2019)
- 1.9.8 (January 16, 2019)
- 1.9.7 (January 15, 2019)
- 1.9.6 (January 15, 2019)
- 1.9.5 (January 14, 2019)
- 1.9.4 (January 11, 2019)
- 1.9.3 (January 9, 2019)
- 1.9.2 (January 4, 2019)
- 1.9.1 (January 3, 2019)
- 1.9.0 (January 2, 2019)
- 1.8.6 / 1.8.7 / 1.8.8 (December 20, 2018)
- 1.8.5 (December 18, 2018)
- 1.8.3 / 1.8.4 (December 18, 2018)
- 1.8.2 (December 18, 2018)
- 1.8.1 (December 12, 2018)
- 1.8.0 (December 11, 2018)
- 1.7.0 (December 7, 2018)
- 1.6.3 (December 4, 2018)
- 1.6.2 (December 4, 2018)
- 1.6.1 (December 4, 2018)
- 1.6.0 (November 23, 2018)
- 1.5.9 (November 17, 2018)
- 1.5.8 (November 14, 2018)
- 1.5.7 (November 12, 2018)
- 1.5.6 (September 30, 2018)
- 1.5.5 (September 27, 2018)
- 1.5.4 (September 26, 2018)
- 1.5.3 (September 24, 2018)
- 1.5.2 (September 12, 2018)
- 1.5.1 (September 4, 2018)
- 1.5.0 (August 17, 2018)
- 1.4.0 (July 23, 2018)
- 1.3.1 (June 19, 2018)
- 1.3.0 (June 7, 2018)
- 1.2.1 (May 28, 2018)
- 1.2.0 (May 25, 2018)
- 1.1.3 (May 17, 2018)
- 1.1.2 (May 17, 2018)
- 1.1.1 (May 15, 2018)
- 1.1.0 (May 12, 2018)
- 1.0.11 (May 11, 2018)
- 1.0.10 (May 4, 2018)
- 1.0.9 (March 20, 2018)
- 1.0.8 (March 18, 2018)
- 1.0.7 (March 16, 2018)
- 1.0.6 (March 16, 2018)
- 1.0.5 (March 12, 2018)
- 1.0.4 (March 12, 2018)
- 1.0.0 -> 1.0.3 (March 12, 2018) First public release
-
README
- consul-templaterb
- Video introduction to consul-templaterb
- Differences with HashiCorp's consul-template
- Installation
- Quick install on Ubuntu-Linux
- Quick install on Windows
- Run it with Docker
- Playing with the samples templates
- Usage of consul-templaterb
- Show help
- Generate multiple templates
- Process management and signalization of configuration files
- Bandwidth limitation
- Samples
- Structured text generation (YAML, JSON, XML…)
- Template development
- Development
- Quick start
- Installation
- Known bugs
- TODO
- Contributing
- License
-
TemplateAPI
- Template API for writing templates
- Common structure of returned objects
- Accessing to statistics to monitor your cluster
- Common re-implemented functions for all objects
- coordinate
- coordinate.datacenters([dc: datacenter])
- coordinate.nodes([dc: datacenter], [agent: consul_agent_address])
- coordinate.rtt(nodeA, nodeB)
- datacenters([agent: consul_agent_address])
- List all datacenters in a text list and count services and nodes within
- services([dc: datacenter], [tag: tagToFilterWith], [agent: consul_agent_address])
- List all services in default datacenter and display its tags
- List all services in all datacenters having tag
http
- service(serviceName, [dc: datacenter], [tag: tagToFilterWith], [passing: true], [agent: consul_agent_address])
- Helpers
- node_meta
- service_address
- service_meta
- service_or_node_meta_value(key)
- status
- weights
- current_weight
- List all services instances with http tag on current DC, instances sorted by node name
- nodes([dc: datacenter], [agent: consul_agent_address])
- List all nodes for DC, sorted by name
- node(nodeNameOrId, [dc: datacenter], [agent: consul_agent_address])
- checks_for_node(name, dc: nil, passing: false, tag: nil, [agent: consul_agent_address])
- checks_for_service(name, dc: nil, passing: false, tag: nil, [agent: consul_agent_address])
- checks_in_state(check_state, dc: nil, [agent: consul_agent_address])
- kv(name, [dc: nil], [keys: false], [recurse: false], [agent: consul_agent_address])
- Using the result of kv
- Get the result of a single value
- Iterate over values
- Fetch all values at once, but interrested only by a few
- agent_members(wan: false, [agent: consul_agent_address])
- agent_metrics([agent: consul_agent_address])
- agent_self([agent: consul_agent_address])
- render_file(relative_path_to_erb_file, [params={}])
- render_from_string(template_to_render, [params={}])
- param(parameter_name, [default_value: nil])
- secrets(prefix, [agent: vault_agent_address])
- List all LDAP entities configured in Vault
- secret(path, [data = nil], [agent: vault_agent_address])
- Read LDAP configuration
- Read a path in non-versionned KV
- remote_resource
- as_json(url, default_value, [refresh_delay_secs: intInSecond])
- template_info()
- Display template info
- Simple rendering
- Rendering with template included into another
- templates
- Display templates info
Classes and Modules
- Consul
- Consul::Async
- Consul::Async::ConsulAgentMetrics
- Consul::Async::ConsulAgentSelf
- Consul::Async::ConsulConfiguration
- Consul::Async::ConsulEndpoint
- Consul::Async::ConsulResult
- Consul::Async::ConsulTemplateAbstract
- Consul::Async::ConsulTemplateAbstractArray
- Consul::Async::ConsulTemplateAbstractJSONArray
- Consul::Async::ConsulTemplateAbstractJSONObject
- Consul::Async::ConsulTemplateAbstractMap
- Consul::Async::ConsulTemplateChecks
- Consul::Async::ConsulTemplateDatacenters
- Consul::Async::ConsulTemplateEngine
- Consul::Async::ConsulTemplateJSONArray
- Consul::Async::ConsulTemplateJSONObject
- Consul::Async::ConsulTemplateKV
- Consul::Async::ConsulTemplateMembers
- Consul::Async::ConsulTemplateNodes
- Consul::Async::ConsulTemplateRender
- Consul::Async::ConsulTemplateRenderedResult
- Consul::Async::ConsulTemplateService
- Consul::Async::ConsulTemplateServices
- Consul::Async::ConsulTemplateVaultSecret
- Consul::Async::ConsulTemplateVaultSecretList
- Consul::Async::Coordinate
- Consul::Async::Debug
- Consul::Async::EndPointStats
- Consul::Async::EndPointsManager
- Consul::Async::HttpResponse
- Consul::Async::InvalidTemplateException
- Consul::Async::JSONConfiguration
- Consul::Async::JSONEndpoint
- Consul::Async::JSONResult
- Consul::Async::ProcessDoesNotExist
- Consul::Async::ProcessHandler
- Consul::Async::RemoteResource
- Consul::Async::SerfMember
- Consul::Async::ServiceInstance
- Consul::Async::SyntaxErrorInTemplate
- Consul::Async::Utilities
- Consul::Async::VaultConfiguration
- Consul::Async::VaultEndpoint
- Consul::Async::VaultHttpResponse
- Consul::Async::VaultResult
Methods
- ::bytes_to_h — Consul::Async::Utilities
- ::level — Consul::Async::Debug
- ::level= — Consul::Async::Debug
- ::levels — Consul::Async::Debug
- ::load_parameters_from_file — Consul::Async::Utilities
- ::new — Consul::Async::ConsulConfiguration
- ::new — Consul::Async::ConsulResult
- ::new — Consul::Async::HttpResponse
- ::new — Consul::Async::ConsulEndpoint
- ::new — Consul::Async::InvalidTemplateException
- ::new — Consul::Async::SyntaxErrorInTemplate
- ::new — Consul::Async::RemoteResource
- ::new — Consul::Async::Coordinate
- ::new — Consul::Async::EndPointsManager
- ::new — Consul::Async::ConsulTemplateAbstract
- ::new — Consul::Async::ConsulTemplateAbstractMap
- ::new — Consul::Async::ConsulTemplateAbstractArray
- ::new — Consul::Async::ServiceInstance
- ::new — Consul::Async::ConsulTemplateService
- ::new — Consul::Async::ConsulTemplateDatacenters
- ::new — Consul::Async::ConsulTemplateServices
- ::new — Consul::Async::ConsulAgentSelf
- ::new — Consul::Async::ConsulAgentMetrics
- ::new — Consul::Async::ConsulTemplateChecks
- ::new — Consul::Async::ConsulTemplateNodes
- ::new — Consul::Async::SerfMember
- ::new — Consul::Async::ConsulTemplateMembers
- ::new — Consul::Async::ConsulTemplateKV
- ::new — Consul::Async::ConsulTemplateVaultSecret
- ::new — Consul::Async::ConsulTemplateEngine
- ::new — Consul::Async::ConsulTemplateRenderedResult
- ::new — Consul::Async::ConsulTemplateRender
- ::new — Consul::Async::JSONConfiguration
- ::new — Consul::Async::JSONResult
- ::new — Consul::Async::JSONEndpoint
- ::new — Consul::Async::ProcessHandler
- ::new — Consul::Async::EndPointStats
- ::new — Consul::Async::VaultConfiguration
- ::new — Consul::Async::VaultResult
- ::new — Consul::Async::VaultHttpResponse
- ::new — Consul::Async::VaultEndpoint
- ::print_debug — Consul::Async::Debug
- ::print_info — Consul::Async::Debug
- ::puts_debug — Consul::Async::Debug
- ::puts_error — Consul::Async::Debug
- ::puts_info — Consul::Async::Debug
- ::random — Consul::Async::Utilities
- #[] — Consul::Async::VaultResult
- #_build_default_template_info — Consul::Async::ConsulTemplateRender
- #_compute_retry_in — Consul::Async::ConsulEndpoint
- #_compute_retry_in — Consul::Async::JSONEndpoint
- #_enable_network_debug — Consul::Async::ConsulEndpoint
- #_enable_network_debug — Consul::Async::JSONEndpoint
- #_enable_network_debug — Consul::Async::VaultEndpoint
- #_get_errors — Consul::Async::VaultEndpoint
- #_handle_error — Consul::Async::ConsulEndpoint
- #_handle_error — Consul::Async::JSONEndpoint
- #_handle_error — Consul::Async::VaultEndpoint
- #_last_429 — Consul::Async::ConsulEndpoint
- #_seen_at — Consul::Async::ConsulTemplateAbstract
- #add_template — Consul::Async::ConsulTemplateEngine
- #add_template_callback — Consul::Async::ConsulTemplateEngine
- #agent_members — Consul::Async::EndPointsManager
- #agent_metrics — Consul::Async::EndPointsManager
- #agent_self — Consul::Async::EndPointsManager
- #as_json — Consul::Async::RemoteResource
- #body_bytes_human — Consul::Async::EndPointStats
- #build_memory_info — Consul::Async::ConsulTemplateEngine
- #build_request — Consul::Async::ConsulEndpoint
- #build_request — Consul::Async::JSONEndpoint
- #build_request — Consul::Async::VaultEndpoint
- #bytes_per_sec — Consul::Async::EndPointStats
- #bytes_per_sec_human — Consul::Async::EndPointStats
- #ch — Consul::Async::ConsulConfiguration
- #ch — Consul::Async::VaultConfiguration
- #checks_for_node — Consul::Async::EndPointsManager
- #checks_for_service — Consul::Async::EndPointsManager
- #checks_in_state — Consul::Async::EndPointsManager
- #create — Consul::Async::ConsulConfiguration
- #create — Consul::Async::JSONConfiguration
- #create — Consul::Async::VaultConfiguration
- #create_if_missing — Consul::Async::EndPointsManager
- #current_weight — Consul::Async::ServiceInstance
- #datacenters — Consul::Async::Coordinate
- #datacenters — Consul::Async::EndPointsManager
- #do_run — Consul::Async::ConsulTemplateEngine
- #do_run_fast — Consul::Async::ConsulTemplateEngine
- #fake? — Consul::Async::ConsulResult
- #fake? — Consul::Async::JSONResult
- #fetch — Consul::Async::ConsulEndpoint
- #fetch — Consul::Async::JSONEndpoint
- #fetch — Consul::Async::VaultEndpoint
- #find — Consul::Async::ConsulTemplateKV
- #find_line — Consul::Async::EndPointsManager
- #find_x_consul_index — Consul::Async::ConsulEndpoint
- #get_lease_duration — Consul::Async::VaultEndpoint
- #get_value — Consul::Async::ConsulTemplateKV
- #get_value_decoded — Consul::Async::ConsulTemplateKV
- #get_value_json — Consul::Async::ConsulTemplateKV
- #get_value_yaml — Consul::Async::ConsulTemplateKV
- #hot_reload_if_needed — Consul::Async::ConsulTemplateRender
- #json — Consul::Async::ConsulResult
- #json — Consul::Async::JSONResult
- #json — Consul::Async::VaultResult
- #kill — Consul::Async::ProcessHandler
- #kv — Consul::Async::EndPointsManager
- #last_success_or_error — Consul::Async::EndPointStats
- #load_template — Consul::Async::ConsulTemplateRender
- #method_missing — Consul::Async::ConsulTemplateAbstract
- #modified? — Consul::Async::ConsulResult
- #modified? — Consul::Async::JSONResult
- #modified? — Consul::Async::VaultResult
- #mutate — Consul::Async::ConsulResult
- #mutate — Consul::Async::JSONResult
- #mutate — Consul::Async::VaultResult
- #next_retry_at — Consul::Async::ConsulResult
- #next_retry_at — Consul::Async::JSONResult
- #node — Consul::Async::EndPointsManager
- #node_meta — Consul::Async::ServiceInstance
- #nodes — Consul::Async::Coordinate
- #nodes — Consul::Async::EndPointsManager
- #on_error — Consul::Async::ConsulEndpoint
- #on_error — Consul::Async::JSONEndpoint
- #on_error — Consul::Async::EndPointStats
- #on_error — Consul::Async::VaultEndpoint
- #on_response — Consul::Async::ConsulEndpoint
- #on_response — Consul::Async::JSONEndpoint
- #on_response — Consul::Async::EndPointStats
- #on_response — Consul::Async::VaultEndpoint
- #param — Consul::Async::EndPointsManager
- #parse_result — Consul::Async::ConsulTemplateAbstract
- #parse_result — Consul::Async::ConsulTemplateServices
- #parse_result — Consul::Async::ConsulTemplateVaultSecretList
- #process_status — Consul::Async::ProcessHandler
- #ready? — Consul::Async::ConsulEndpoint
- #ready? — Consul::Async::ConsulTemplateAbstract
- #ready? — Consul::Async::ConsulTemplateRenderedResult
- #ready? — Consul::Async::JSONEndpoint
- #ready? — Consul::Async::VaultEndpoint
- #reload — Consul::Async::ProcessHandler
- #render — Consul::Async::EndPointsManager
- #render — Consul::Async::ConsulTemplateRender
- #render_file — Consul::Async::EndPointsManager
- #render_from_string — Consul::Async::EndPointsManager
- #respond_to_missing? — Consul::Async::ConsulTemplateAbstract
- #result_delegate — Consul::Async::ConsulTemplateAbstract
- #result_delegate — Consul::Async::ConsulTemplateService
- #result_delegate — Consul::Async::ConsulTemplateMembers
- #rtt — Consul::Async::Coordinate
- #run — Consul::Async::ConsulTemplateEngine
- #run — Consul::Async::ConsulTemplateRender
- #secret — Consul::Async::EndPointsManager
- #secrets — Consul::Async::EndPointsManager
- #serf_statuses — Consul::Async::SerfMember
- #service — Consul::Async::EndPointsManager
- #service_address — Consul::Async::ServiceInstance
- #service_meta — Consul::Async::ServiceInstance
- #service_or_node_meta_value — Consul::Async::ServiceInstance
- #services — Consul::Async::EndPointsManager
- #start — Consul::Async::ProcessHandler
- #status — Consul::Async::ServiceInstance
- #status — Consul::Async::SerfMember
- #template_info — Consul::Async::EndPointsManager
- #terminate — Consul::Async::ConsulEndpoint
- #terminate — Consul::Async::EndPointsManager
- #terminate — Consul::Async::JSONEndpoint
- #terminate — Consul::Async::VaultEndpoint
- #update_template — Consul::Async::ConsulTemplateRender
- #vault_setup_token_renew — Consul::Async::EndPointsManager
- #weights — Consul::Async::ServiceInstance
- #write — Consul::Async::EndPointsManager
- #write — Consul::Async::ConsulTemplateRender