greentic-deploy-spec 0.1.27231730823

Greentic deployment object-model schemas (Environment, Revision, TrafficSplit, BundleDeployment, Credentials, PackConfig, RuntimeConfig)
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

//! Identifier newtypes used across the deployment object model.
//!
//! `EnvId` is re-exported from `greentic-types`. `RevisionId` and `DeploymentId`
//! are ULIDs (monotonically sortable, 26-char Crockford base32). `BundleId`,
//! `CustomerId`, `PackId`, and `PartyId` are opaque strings — format and
//! authoritative source live outside this crate.

use serde::{Deserialize, Serialize};
use std::fmt;
use ulid::Ulid;

/// ULID-shaped identifier for a revision (`§5.2`).
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
#[serde(transparent)]
pub struct RevisionId(pub Ulid);

impl RevisionId {
    pub fn new() -> Self {
        Self(Ulid::new())
    }
}

impl Default for RevisionId {
    fn default() -> Self {
        Self::new()
    }
}

impl fmt::Display for RevisionId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

/// ULID-shaped identifier for a [`BundleDeployment`](crate::BundleDeployment) (`§5.4`).
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
#[serde(transparent)]
pub struct DeploymentId(pub Ulid);

impl DeploymentId {
    pub fn new() -> Self {
        Self(Ulid::new())
    }
}

impl Default for DeploymentId {
    fn default() -> Self {
        Self::new()
    }
}

impl fmt::Display for DeploymentId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

/// ULID-shaped identifier for a
/// [`MessagingEndpoint`](crate::MessagingEndpoint) (`Phase M`).
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
#[serde(transparent)]
pub struct MessagingEndpointId(pub Ulid);

impl MessagingEndpointId {
    pub fn new() -> Self {
        Self(Ulid::new())
    }
}

impl Default for MessagingEndpointId {
    fn default() -> Self {
        Self::new()
    }
}

impl fmt::Display for MessagingEndpointId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

macro_rules! string_id {
    ($(#[$meta:meta])* $name:ident) => {
        $(#[$meta])*
        #[derive(Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
        #[serde(transparent)]
        pub struct $name(pub String);

        impl $name {
            pub fn new(s: impl Into<String>) -> Self {
                Self(s.into())
            }

            pub fn as_str(&self) -> &str {
                &self.0
            }
        }

        impl fmt::Display for $name {
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str(&self.0)
            }
        }

        impl From<String> for $name {
            fn from(s: String) -> Self {
                Self(s)
            }
        }

        impl From<&str> for $name {
            fn from(s: &str) -> Self {
                Self(s.to_string())
            }
        }
    };
}

string_id!(
    /// Stable identifier for a bundle (`bundle_id` field across §5.2–5.4).
    BundleId
);

string_id!(
    /// Billing principal identifier (`§5.4`). Defaults to `local-dev` for `local` env.
    CustomerId
);

string_id!(
    /// Pack identifier (`§5.2`). Resolves through the pack store.
    PackId
);

string_id!(
    /// Revenue-share party identifier (`§5.4`).
    PartyId
);