greentic-types 0.5.2

Shared primitives for Greentic: TenantCtx, InvocationEnvelope, NodeError, ids.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

//! Generic deployment planning structures shared between packs, runners, and deployers.

use alloc::string::String;
use alloc::vec::Vec;

use crate::SecretRequirement;
use semver::Version;

#[cfg(feature = "schemars")]
use schemars::JsonSchema;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Provider-agnostic deployment description shared across tools.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "schemars", derive(JsonSchema))]
pub struct DeploymentPlan {
    /// Pack being deployed.
    pub pack_id: String,
    /// Pack version.
    #[cfg_attr(
        feature = "schemars",
        schemars(with = "String", description = "SemVer version")
    )]
    pub pack_version: Version,
    /// Tenant identifier.
    pub tenant: String,
    /// Environment identifier.
    pub environment: String,
    /// Logical runtime topology.
    pub runners: Vec<RunnerPlan>,
    /// Messaging fabric description.
    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "Option::is_none")
    )]
    pub messaging: Option<MessagingPlan>,
    /// Channel entrypoints into the pack.
    pub channels: Vec<ChannelPlan>,
    /// Secrets required to operate the pack.
    pub secrets: Vec<SecretRequirement>,
    /// OAuth client requirements.
    pub oauth: Vec<OAuthPlan>,
    /// Telemetry guidance.
    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "Option::is_none")
    )]
    pub telemetry: Option<TelemetryPlan>,
    /// Free-form extension space.
    #[cfg_attr(feature = "serde", serde(default))]
    pub extra: Value,
}

/// Runner sizing and capabilities plan.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "schemars", derive(JsonSchema))]
pub struct RunnerPlan {
    /// Logical runner name.
    pub name: String,
    /// Desired concurrency level.
    pub replicas: u32,
    /// Additional hints/capabilities (opaque).
    #[cfg_attr(feature = "serde", serde(default))]
    pub capabilities: Value,
}

/// Messaging cluster plan.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "schemars", derive(JsonSchema))]
pub struct MessagingPlan {
    /// Logical cluster identifier.
    pub logical_cluster: String,
    /// Subjects/streams required by the pack.
    pub subjects: Vec<MessagingSubjectPlan>,
    /// Extension metadata.
    #[cfg_attr(feature = "serde", serde(default))]
    pub extra: Value,
}

/// Messaging subject plan entry.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "schemars", derive(JsonSchema))]
pub struct MessagingSubjectPlan {
    /// Subject/stream name.
    pub name: String,
    /// Intended use.
    pub purpose: String,
    /// Whether durability is required.
    pub durable: bool,
    /// Extension metadata.
    #[cfg_attr(feature = "serde", serde(default))]
    pub extra: Value,
}

/// Channel entrypoint description.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "schemars", derive(JsonSchema))]
pub struct ChannelPlan {
    /// Logical channel name.
    pub name: String,
    /// Flow entrypoint.
    pub flow_id: String,
    /// Connector kind (opaque).
    pub kind: String,
    /// Connector-specific configuration.
    #[cfg_attr(feature = "serde", serde(default))]
    pub config: Value,
}

/// OAuth client requirement entry.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "schemars", derive(JsonSchema))]
pub struct OAuthPlan {
    /// Provider identifier.
    pub provider_id: String,
    /// Logical client identifier.
    pub logical_client_id: String,
    /// Redirect path relative to host choice.
    pub redirect_path: String,
    /// Extension metadata.
    #[cfg_attr(feature = "serde", serde(default))]
    pub extra: Value,
}

/// Telemetry configuration hints.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "schemars", derive(JsonSchema))]
pub struct TelemetryPlan {
    /// Whether telemetry must be configured.
    pub required: bool,
    /// Optional suggested endpoint.
    #[cfg_attr(
        feature = "serde",
        serde(default, skip_serializing_if = "Option::is_none")
    )]
    pub suggested_endpoint: Option<String>,
    /// Extension metadata.
    #[cfg_attr(feature = "serde", serde(default))]
    pub extra: Value,
}