bookclerk_library::entities::plugin_deployment_observations

Development These docs follow the development version and change with every merge.

Last updated View as Markdown

SeaORM entity for observed plugin deployment state.

Item Kind Summary
Model struct Row shape for one host's observation of a deployment.
ColumnIter struct An iterator over the variants of [Column]
Entity struct Generated by sea-orm-macros
PrimaryKeyIter struct An iterator over the variants of [PrimaryKey]
ActiveModel struct Generated by sea-orm-macros
RelationIter struct An iterator over the variants of [Relation]
Column enum Generated by sea-orm-macros
PrimaryKey enum Generated by sea-orm-macros
Relation enum Declared SeaORM relations (observations are addressed by deployment and host).

Structs

Model

pub struct Model {
    pub deployment_id: String,
    pub node_id: String,
    pub incarnation: String,
    pub status: String,
    pub detail: String,
    pub applied_config_revision: Option<i64>,
    pub observed_at: String,
    pub reserved_memory_bytes: Option<i64>,
    pub reserved_cpu_millicores: Option<i64>,
}

Row shape for one host's observation of a deployment.

Written only by the reconciler on that host. A desired row does not create this row.

Fields

  • deployment_id: Deployment this observation describes.
  • node_id: Host that recorded the observation. Matches the deployment target when local.
  • incarnation: Process incarnation that recorded the row.
  • status: materialized, running, healthy, error, or retired.
  • detail: Bounded detail. Empty when the status is healthy.
  • applied_config_revision: Config revision applied by the last spawn. Null until a spawn applies one.
  • observed_at: RFC 3339 timestamp of this observation.
  • reserved_memory_bytes: Memory ceiling of the running guest (its grant after [plugins.jail]).
  • reserved_cpu_millicores: CPU ceiling of the running guest, in millicores.

Model::into_ex

pub fn into_ex(self) -> Self

Generated by sea-orm-macros

Implements: Clone, Debug, Eq, From<Model>, FromQueryResult, IntoActiveModel<ActiveModel>, ModelTrait, PartialEq, TryFrom<ActiveModel>, TryIntoModel<Model>

ColumnIter

pub struct ColumnIter {
    /* private fields */
}

An iterator over the variants of Column

Implements: Clone, Debug, DoubleEndedIterator, ExactSizeIterator, FusedIterator, Iterator

Entity

pub struct Entity;

Generated by sea-orm-macros

Implements: Clone, Copy, Debug, Default, EntityName, EntityTrait, Iden, IdenStatic

PrimaryKeyIter

pub struct PrimaryKeyIter {
    /* private fields */
}

An iterator over the variants of PrimaryKey

Implements: Clone, Debug, DoubleEndedIterator, ExactSizeIterator, FusedIterator, Iterator

ActiveModel

pub struct ActiveModel {
    pub deployment_id: ActiveValue<String>,
    pub node_id: ActiveValue<String>,
    pub incarnation: ActiveValue<String>,
    pub status: ActiveValue<String>,
    pub detail: ActiveValue<String>,
    pub applied_config_revision: ActiveValue<Option<i64>>,
    pub observed_at: ActiveValue<String>,
    pub reserved_memory_bytes: ActiveValue<Option<i64>>,
    pub reserved_cpu_millicores: ActiveValue<Option<i64>>,
}

Generated by sea-orm-macros

Fields

  • deployment_id: Generated by sea-orm-macros
  • node_id: Generated by sea-orm-macros
  • incarnation: Generated by sea-orm-macros
  • status: Generated by sea-orm-macros
  • detail: Generated by sea-orm-macros
  • applied_config_revision: Generated by sea-orm-macros
  • observed_at: Generated by sea-orm-macros
  • reserved_memory_bytes: Generated by sea-orm-macros
  • reserved_cpu_millicores: Generated by sea-orm-macros

Implements: ActiveModelBehavior, ActiveModelTrait, Clone, Debug, Default, From<Model>, IntoActiveModel<ActiveModel>, PartialEq, TryFrom<ActiveModel>, TryIntoModel<Model>

RelationIter

pub struct RelationIter {
    /* private fields */
}

An iterator over the variants of Relation

Implements: Clone, Debug, DoubleEndedIterator, ExactSizeIterator, FusedIterator, Iterator

Enums

Column

pub enum Column {
    DeploymentId,
    NodeId,
    Incarnation,
    Status,
    Detail,
    AppliedConfigRevision,
    ObservedAt,
    ReservedMemoryBytes,
    ReservedCpuMillicores,
}

Generated by sea-orm-macros

Variants

  • DeploymentId: Generated by sea-orm-macros
  • NodeId: Generated by sea-orm-macros
  • Incarnation: Generated by sea-orm-macros
  • Status: Generated by sea-orm-macros
  • Detail: Generated by sea-orm-macros
  • AppliedConfigRevision: Generated by sea-orm-macros
  • ObservedAt: Generated by sea-orm-macros
  • ReservedMemoryBytes: Generated by sea-orm-macros
  • ReservedCpuMillicores: Generated by sea-orm-macros

Implements: Clone, ColumnTrait, Copy, Debug, FromStr, Iden, IdenStatic, IntoEnumIterator

PrimaryKey

pub enum PrimaryKey {
    DeploymentId,
    NodeId,
}

Generated by sea-orm-macros

Variants

  • DeploymentId: Generated by sea-orm-macros
  • NodeId: Generated by sea-orm-macros

Implements: Clone, Copy, Debug, Iden, IdenStatic, IntoEnumIterator, PrimaryKeyToColumn, PrimaryKeyTrait

Relation

pub enum Relation {}

Declared SeaORM relations (observations are addressed by deployment and host).

Implements: Clone, Copy, Debug, IntoEnumIterator, RelationTrait

Generated from crates/bookclerk-library at main · View as Markdown