https://github.com/sitewhere/sitewhere-k8s-model
The SiteWhere Kubernetes resource model provides custom resource definitions for managing SiteWhere instances in Kubernetes.
https://github.com/sitewhere/sitewhere-k8s-model
kubernetes sitewhere
Last synced: about 2 months ago
JSON representation
The SiteWhere Kubernetes resource model provides custom resource definitions for managing SiteWhere instances in Kubernetes.
- Host: GitHub
- URL: https://github.com/sitewhere/sitewhere-k8s-model
- Owner: sitewhere
- Created: 2019-10-13T12:46:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-06T15:12:29.000Z (about 5 years ago)
- Last Synced: 2025-07-03T08:08:24.850Z (11 months ago)
- Topics: kubernetes, sitewhere
- Language: Java
- Homepage: https://sitewhere.io
- Size: 330 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SiteWhere Kubernetes Model
The SiteWhere Kubernetes resource model contains Java entities which correspond
to k8s [custom resource definitions](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/).
The following resources are included in the SiteWhere Kubernetes resource model. Resources are scoped at either the global
instance level or at the tenant level.
## Instance Global Resources
### `SiteWhereInstance`
Delares a SiteWhere instance which creates name and namespace for other
resources to be attached to. This resource contains the global instance
configuration which is bootstrapped using a reference to an
`InstanceConfigurationTemplate`.
### `InstanceConfigurationTemplate`
Specifies global configuration options which may be used when creating
a new instance. A `SiteWhereInstance` references a instance configuration
template by name in order to bootstrap the configuration.
### `InstanceDatasetTemplate`
Specifies a set of scripts which are executed to populate instance data
such as an intial list of tenants and users.
### `SiteWhereMicroservice`
Configures a microservice which is associated with a `SiteWhereInstance`.
## Tenant Resources
### `SiteWhereTenant`
Creates a tenant associated with a `SiteWhereInstance`. Each tenant has tenant
engines which run within a `SiteWhereMicroservice`.
### `SiteWhereTenantEngine`
Specifies the configuration and other details for a single tenant engine
(microservice + tenant combination). When a new tenant is initially added, the
tenant engine configuration is copied based on the `TenantEngineConfigurationTemplate`
associated with the tenant.
### `TenantConfigurationTemplate`
Gathers a list of `TenantEngineConfigurationTemplate` that will be used for a given
tenant configuration.
### `TenantEngineConfigurationTemplate`
Specifies a tenant-level configuration options which are used to set the
initial configuration for the tenant engines running within the microservices.
### `TenantEngineDatasetTemplate`
Specifies a set of scripts which are used to populate initial data an individual
microservice. For instance, tenant dataset templates may be used to create device
types, devices, customers, areas, etc in order to pre-populate tenants with data.