| 123456789101112131415161718192021222324252627282930313233343536373839404142434445 |
- [#entities]
- = Entities
- An entity is something that exists - a "thing", like a VM, or a Container is an entity. OliveTin allows you to then dynamically generate actions based around these entities.
- This is really useful if you want to generate wake on lan or poweroff actions for `server` entities, for example.
- A very popular use case that entities were designed for was for `container` entities - in a similar way you could generate `start`, `stop`, and `restart` container actions.
- Entities are just loaded from files on disk, OliveTin will also watch these files for updates while OliveTin is running, and update entities.
- Entity data files can contain any fields you need. Those values are available in action templates as `{{ .CurrentEntity.field }}` — for example, `{{ .CurrentEntity.status }}` or `{{ .CurrentEntity.hostname }}`.
- To control which fields appear in the Entities page table and entity details view, configure `properties` on the entity definition in `config.yaml`. See xref:entities/properties.adoc[Entity properties] for details.
- [source,yaml]
- ----
- entities:
- - file: /etc/OliveTin/containers.json
- name: container
- - file: /etc/OliveTin/servers.yaml
- name: server
- icon: ssh
- properties:
- - name: hostname
- title: Hostname
- - name: ip
- title: IP
- ----
- Entity Actions can only be used on xref:dashboards/intro.adoc[Dashboards].
- == What's Next?
- Now that you understand entities, here's how to use them effectively:
- * xref:entities/properties.adoc[Configure entity properties] - Choose which fields appear in the UI and API
- * xref:entities/icons.adoc[Configure entity icons] - Set an icon for each entity type
- * xref:entities/yaml.adoc[Create YAML entity files] - Learn the YAML format for entity files
- * xref:entities/json.adoc[Create JSON entity files] - Learn the JSON format for entity files
- * xref:entities/examples.adoc[View entity examples] - See complete examples of entity configurations
- * xref:dashboards/intro.adoc[Use entities in dashboards] - Combine entities with dashboards for dynamic action generation
- * xref:solutions/container-control-panel/index.adoc[Container control panel solution] - See a complete example using container entities
- * xref:solutions/systemd-control-panel/index.adoc[Systemd control panel solution] - See a complete example using systemd entities
|
