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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
//! `compose-validatr` is a library for validating and building valid [Docker Compose](https://docs.docker.com/compose/compose-file/) manifests that are not dependent on the host system.
//!
//! # Table of Contents
//!
//! - [High-level features](#high-level-features)
//! - [Purpose](#purpose)
//! - [Examples](#examples)
//!
//!
//! # High-level Features
//!
//! - Create and validate a Docker Compose structure from `&str`
//! - Access the fields for a Compose manifest
//! - View multiple validation errors at once
//!
//! # Purpose
//!
//! The main purpose of this library is for building and validating Docker Compose manifests
//! in contexts that are agnostic to a host machine. This is useful for web applications
//! that want to visualize existing Compose manifests or create valid manifests without
//! caring if host files or devices are present.
//!
//! # Examples
//!
//! ```rust
//! use compose_validatr::Compose;
//!
//! let yaml = r#"
//! services:
//! gitlab:
//! image: gitlab/gitlab-ce:latest
//! container_name: gitlab
//! hostname: gitlab
//! restart: always
//! build:
//! context: .
//! dockerfile: webapp.Dockerfile
//! "#;
//!
//! let compose = Compose::new(yaml).unwrap();
//! compose.services.keys().for_each(|service_name| println!("Service: {service_name}"));
//! ```
//!
//! ```rust
//! use compose_validatr::Compose;
//!
//! let yaml = r#"
//! version: '3.9'
//! services:
//! gitlab:
//! image: gitlab/gitlab-ce:latest
//! container_name: gitlab
//! hostname: gitlab
//! restart: always
//! depends_on:
//! - postgres
//! ports:
//! - "8080:80"
//! - "8443:443"
//! - "8022:22"
//! environment:
//! GITLAB_ROOT_PASSWORD: eYPkjBbrtzX8eGVc
//! DATABASE_URL: "postgres://gitlab:eYPkjBbrtzX8eGVc@postgres:5432/gitlab"
//! volumes:
//! - ./gitlab/config:/etc/gitlab
//! - ./gitlab/logs:/var/log/gitlab
//! - ./gitlab/data:/var/opt/gitlab
//! shm_size: '256m'
//!
//! registry:
//! image: registry:2
//! container_name: registry
//! hostname: registry
//! ports:
//! - "5000:5000"
//! volumes:
//! - registry:/var/lib/registry
//!
//! sonarqube:
//! build:
//! context: ./sonarqube_image
//! container_name: sonarqube
//! hostname: sonarqube
//! restart: always
//! ports:
//! - "9000:9000"
//! - "9092:9092"
//! volumes:
//! - sonarqube:/opt/sonarqube/data
//! - sonarqube:/opt/sonarqube/logs
//! - sonarqube:/opt/sonarqube/extensions
//!
//! jenkins:
//! build:
//! context: ./jenkins_image
//! container_name: jenkins
//! hostname: jenkins
//! restart: always
//! ports:
//! - "9080:8080"
//! - "50000:50000"
//! volumes:
//! - jenkins:/var/jenkins_home
//! - jenkins-data:/var/jenkins_home
//! - jenkins-docker-certs:/certs/client:ro
//! environment:
//! - JAVA_OPTS=-Djenkins.install.runSetupWizard=false
//! - DOCKER_HOST=tcp://docker:2376
//! - DOCKER_CERT_PATH=/certs/client
//! - DOCKER_TLS_VERIFY=1
//!
//! jenkins-docker:
//! image: docker:dind
//! container_name: jenkins-docker
//! hostname: docker
//! privileged: true
//! environment:
//! - DOCKER_TLS_CERTDIR=/certs
//! volumes:
//! - /etc/docker/daemon.json:/etc/docker/daemon.json
//! - jenkins-docker-certs:/certs/client
//! - jenkins-data:/var/jenkins_home
//! ports:
//! - '2376:2376'
//! command: --storage-driver overlay2
//!
//! postgres:
//! image: postgres:latest
//! container_name: postgres
//! hostname: postgres
//! restart: always
//! ports:
//! - "5432:5432"
//! volumes:
//! - postgres:/var/lib/postgresql/data
//! environment:
//! POSTGRES_DB: gitlab
//! POSTGRES_USER: gitlab
//! POSTGRES_PASSWORD: eYPkjBbrtzX8eGVc
//!
//! volumes:
//! sonarqube:
//! jenkins:
//! jenkins-docker-certs:
//! jenkins-data:
//! postgres:
//! registry:
//!
//! networks:
//! default:
//! driver: bridge
//! "#;
//!
//! // Create a new `Compose` from the &str. This will return a Result<Compose, ValidationErrors>
//! let compose = Compose::new(yaml);
//! match &compose {
//! Ok(c) => {
//! // Compose is valid. A lot of Compose fields are optional, so maps are very useful here
//! c.version.as_ref().map(|v| println!("Version: {v}"));
//! ()
//! }
//! Err(errors) => {
//! // Compose had one or many errors
//! ()
//! }
//! }
//! ```
pub use crateCompose;