type_description 0.5.0

Machine-readable type descriptions
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

//
//   This Source Code Form is subject to the terms of the Mozilla Public
//   License, v. 2.0. If a copy of the MPL was not distributed with this
//   file, You can obtain one at http://mozilla.org/MPL/2.0/.
//

use std::collections::HashMap;

use type_description::{AsTypeDescription, TypeDescription};

/// How to configure a kubernetes cluster
///
/// # Example
///
/// ```toml
/// [[cluster]]
/// api_version = "25"
/// ```
///
/// As you can see, this is rendered __with__ _full_ support.
#[derive(Debug, TypeDescription)]
pub struct KubeConfig {
    /// The API version of the kubernetes cluster
    pub api_version: String,
    pub clusters: Vec<Cluster>,
    pub contexts: Vec<Context>,
    pub current_context: String,
    pub kind: String,
    pub users: Vec<User>,
    pub values: HashMap<String, bool>,
}

#[derive(Debug, TypeDescription)]
pub struct Cluster {
    pub name: String,
    pub cluster: ClusterDetail,
}

#[derive(Debug, TypeDescription)]
pub struct ClusterDetail {
    pub insecure_skip_tls_verify: Option<bool>,
    pub certificate_authority: Option<String>,
    pub certificate_authority_data: Option<String>,
    pub server: String,
}

#[derive(Debug, TypeDescription)]
pub struct User {
    pub name: String,
    pub user: UserDetail,
}

#[derive(Debug, TypeDescription)]
pub struct UserDetail {
    pub auth_provider: Option<AuthProviderDetail>,
    pub client_certificate: Option<String>,
    pub client_key: Option<String>,
    pub client_certificate_data: Option<String>,
    pub client_key_data: Option<String>,
    pub exec: Option<Exec>,
    pub token: Option<String>,
    pub username: Option<String>,
    pub password: Option<String>,
}

#[derive(Debug, TypeDescription)]
pub struct Exec {
    pub api_version: String,
    pub args: Vec<String>,
    pub command: String,
}

#[derive(Debug, TypeDescription)]
#[description(tag = "name")]
pub enum AuthProviderDetail {
    Gcp(GcpAuthProviderConfig),

    Other,
}

#[derive(Debug, TypeDescription)]
pub struct GcpAuthProviderConfig {
    pub access_token: Option<String>,
    pub cmd_args: String,
    pub cmd_path: String,
    pub expiry: Option<String>,
    pub expiry_key: String,
    pub token_key: String,
}

#[derive(Debug, TypeDescription)]
pub struct Context {
    pub name: String,
    pub context: ContextDetail,
}

#[derive(Debug, TypeDescription)]
pub struct ContextDetail {
    pub cluster: String,
    pub user: String,
    pub namespace: Option<String>,
}

#[test]
fn check_complex_type_desc() {
    let desc = KubeConfig::as_type_description();

    println!(
        "{}",
        serde_json::to_string(&desc).expect("SHould be able to serialize to json")
    );
}