Static manifests¶
Overview¶
If you have infrastructure on-site, or in any other provider for which Bcome does not yet provide a driver, you may utilise a Static Manifest.
A Static Manifest is a list of manually configured servers that can be used to populate a specified Inventory.
For example, consider the following simple Network configuration:
---
estate:
type: collection
description: My Collection
estate:onsite:
type: inventory
description: My onsite inventory
Above we have defined a Collection housing a single Inventory (see Namespaces). There is no Network defined (see: Namespace attributes), and therefore no configured cloud provider to populate the Inventory.
Now create a file called static-cache.yml
and save it to your Bcome configuration directory as follows:
.
├── Gemfile
└── bcome
└── networks.yml
└── static-cache.yml
Here’s a simple example of a Static Manifest entry within our static-cache.yml file that would populate our Inventory with two servers:
---
estate:onsite:
- identifier: file_server_one
public_ip_address: 123.123.123.12
description: My server
cloud_tags:
data:
a_key: a_value
another_key: another_value
- identifier: some_other_server
public_ip_address: 678.678.678.67
internal_ip_address: 10.2.23.12
description: My other server
Attribute List¶
attribute key | description | optional | notes |
---|---|---|---|
identifier | The server name. | No | Bcome will automatically swap whitespace for underscores, and auto-increment duplicate identifiers. A server’s identifier is incorporated into its namespace breadcrumb. |
description | The server description | No | A description of the server. This will appear in Bcome’s UI. |
public_ip_address | The public interface IP address. | Yes | You may use a hostname here also. |
internal_ip_address | The internal interface IP address. | Yes | You may use a hostname here also. |
local_network | Set to true or false. Indicates whether the server is to be found on the local network. |
Yes | If a set with local_network: true, Bcome will initiate SSH connections on the internal_ip_address. If set to false, connections will fallback to proxy (if configured in the namespace’s network configuration) or to the public_ip_address. |
cloud_tags | A Hash of tags keys and values, keyed on :data | Yes | See Tag attributes for structure |
Tag attributes¶
Cloud tag attributes have the following YAML structure:
---
cloud_tags:
data:
tag_key_1: tag_value_1
tag_key_2: tag_value_2