-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathquickstart.html
302 lines (262 loc) · 14.3 KB
/
quickstart.html
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="yandex-verification" content="00bf34bc7a08335d"/>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-137858449-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag() {
dataLayer.push(arguments);
}
gtag('js', new Date());
gtag('config', 'UA-137858449-1');
</script>
<!-- Yandex.Metrika counter -->
<script type="text/javascript">
(function (m, e, t, r, i, k, a) {
m[i] = m[i] || function () {
(m[i].a = m[i].a || []).push(arguments)
};
m[i].l = 1 * new Date();
k = e.createElement(t), a = e.getElementsByTagName(t)[0], k.async = 1, k.src = r, a.parentNode.insertBefore(k, a)
})
(window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
ym(62712055, "init", {
clickmap: true,
trackLinks: true,
accurateTrackBounce: true,
webvisor: true
});
</script>
<noscript>
<div><img src="https://mc.yandex.ru/watch/62712055" style="position:absolute; left:-9999px;" alt=""/></div>
</noscript>
<!-- /Yandex.Metrika counter -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta content="microservice configuration, configuration, cloud native, cloud native configuration, kubernetes, helm, configuration management, external configuration, configuration processor, configuration management tools, application configuration"
name="keywords">
<meta content="Microconfig is a modern and simple way to manage microservice configuration. Especially in the Cloud."
name="description">
<link href="vendor/bootstrap/bootstrap.min.css" rel="stylesheet">
<link href="vendor/prism/prism.css" rel="stylesheet">
<link href="css/styles.css" rel="stylesheet">
<link href="bloggersans/bloggersans.css" rel="stylesheet">
<link rel="icon" href="css/favicon.ico">
<title>Microconfig.io - Microservice Configuration Made Easy</title>
</head>
<body>
<header>
<nav class="navbar navbar-expand-md navbar-light shadow-sm">
<div class="container">
<a href="./" class="navbar-brand">
<img style="height: 97px;" src="images/microconfig_logo_horizontal.svg" alt="Microconfig" />
</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarResponsive">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarResponsive">
<ul class="navbar-nav ml-auto">
<li class="nav-item">
<a class="nav-link text-dark" href="features.html">Features</a>
</li>
<li class="nav-item nav-active">
<a class="nav-link text-dark" href="quickstart.html">Quickstart</a>
</li>
<li class="nav-item">
<a class="nav-link text-dark" href="download.html">Download</a>
</li>
<li class="nav-item">
<a class="nav-link text-dark" href="plugin.html">IDE plugin</a>
</li>
<li class="nav-item">
<a class="nav-link text-dark" href="server.html">Server</a>
</li>
<li class="nav-item">
<a class="nav-link text-dark" href="documentation.html">Docs</a>
</li>
</ul>
</div>
</div>
</nav>
</header>
<a href="https://github.com/microconfig/microconfig" class="github-corner" aria-label="View source on GitHub">
<svg width="80" height="80" viewBox="0 0 250 250"
style="fill:#5fbb92; color:#fff; position: fixed; top: 0; border: 0; right: 0;z-index: 100"
aria-hidden="true">
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
<path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2"
fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path>
<path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z"
fill="currentColor" class="octo-body"></path>
</svg>
</a>
<main role="main" id="download">
<section class="jumbotron">
<div class="container">
<h1 id="quickstart" class="text-center">Quickstart</h1>
<p>You will learn how to build configuration with Microconfig.</p>
<br />
<section>
<h2 class="" id="setup">Setup</h2><br />
<h3 class="mc-green" id="example-repository">Get Example Config</h3>
<p>Checkout with <code>git</code></p>
<pre><code class="language-bash">
git clone https://github.com/microconfig/microconfig-quickstart.git
cd microconfig-quickstart
</code></pre>
<p>Or just <a
href="https://github.com/microconfig/microconfig-quickstart/archive/master.zip">download</a>
and unzip it directly.</p>
<br />
<h3 class="mc-green" id="microconfig-jar">Get Microconfig</h3>
<p><a href="download.html">Download</a> the latest binary for your OS.</p>
<br />
<h3 class="mc-green" id="example-configuration">Config Structure</h3>
<p>Our configuration example has 2 services:</p>
<ul>
<li><code>payments-backend</code></li>
<li><code>payments-frontend</code></li>
</ul>
<p>Services are combined into <code>payments</code> group.</p>
<p>We have environment specific values for 2 environments:</p>
<ul>
<li><code>dev</code></li>
<li><code>prod</code></li>
</ul>
<p>Each service expects 3 files:</p>
<ul>
<li><code>application.yaml</code> - application config</li>
<li><code>deploy.yaml</code> - deployment config</li>
<li><code>logback.xml</code> - logging configuration</li>
</ul>
<br />
</section>
<h2 class="" id="build">Build</h2><br />
<p>Examples assume that you run your build in quickstart repository dir.</p>
<br />
<h3 class="mc-green" id="specific-env-one">Generate configuration for a service in a specific
environment</h3>
<p>Let's generate configuration for <code>payments-backend</code> service in <code>dev</code>
environment.
</p>
<pre><code class="language-bash">
microconfig -r . -e dev -s payment-backend
Filtered 1 component(s) in [dev] env.
Copied 'payment-backend' template ../log/logback.xml -> logback.xml
Generated payment-backend/application.yaml
Generated payment-backend/deploy.yaml
Generated [dev] configs in 265ms
</code></pre>
<p><strong>Parameters: </strong></p>
<ul>
<li><code>-r . </code> specify root dir (optional)</li>
<li><code>-e dev </code> generate for <code>dev</code> environment</li>
<li><code>-s payments-backend </code> generate for <code>payments-backend</code> service</li>
</ul>
<p>As a result Microconfig created <code>build</code> folder with <code>dev</code> configs for
<code>payments-backend</code>.
</p>
<pre><code class="language-bash">
build
└── payment-backend
├── application.yaml
├── deploy.yaml
└── logback.xml
</code></pre>
<br /><br />
<h3 class="mc-green" id="specific-env-group">Generate configuration for a group in a specific
environment</h3>
<p>Let's generate configuration for <code>payments</code> group in <code>prod</code> environment.</p>
<pre><code class="language-bash">
microconfig -e prod -g payments
Filtered 2 component(s) in [prod] env.
Copied 'payment-backend' template ../log/logback.xml -> logback.xml
Copied 'payment-frontend' template ../log/logback.xml -> logback.xml
Generated payment-backend/application.yaml
Generated payment-backend/deploy.yaml
Generated payment-frontend/application.yaml
Generated payment-frontend/deploy.yaml
Generated [prod] configs in 325ms
</code></pre>
<p>Parameters: </p>
<ul>
<li><code>-e prod </code> generate for <code>prod</code> environment</li>
<li><code>-g payments </code> generate for <code>payments</code> group</li>
</ul>
<p>As a result Microconfig created <code>build</code> folder with <code>prod</code> configs for
<code>payments</code> group.</p>
<pre><code class="language-bash">
build
├── payment-backend
│ ├── application.yaml
│ ├── deploy.yaml
│ └── logback.xml
└── payment-frontend
├── application.yaml
├── deploy.yaml
└── logback.xml
</code></pre>
<br /><br />
<h3 class="mc-green" id="specific-env-all">Generate configuration for all services in a specific
environment</h3>
<p>Let's generate configuration for all services in <code>dev</code> environment.</p>
<pre><code class="language-bash">
microconfig -e dev
Filtered 2 component(s) in [dev] env.
Copied 'payment-frontend' template ../log/logback.xml -> logback.xml
Copied 'payment-backend' template ../log/logback.xml -> logback.xml
Generated payment-backend/application.yaml
Generated payment-backend/deploy.yaml
Generated payment-frontend/application.yaml
Generated payment-frontend/deploy.yaml
Generated [dev] configs in 326ms
</code></pre>
<p>Parameters: </p>
<ul>
<li><code>-e dev</code> generate for <code>dev</code> environment</li>
</ul>
<p>As a result Microconfig created <code>build</code> folder with configs for all services defined in
<code>dev</code>
environment.</p>
<pre><code class="language-bash">
build
├── payment-backend
│ ├── application.yaml
│ ├── deploy.yaml
│ └── logback.xml
└── payment-frontend
├── application.yaml
├── deploy.yaml
└── logback.xml
</code></pre>
<br /><br />
<h2 class="" id="conclusion">Conclusion</h2>
<p>We hope you agree that microconfig is easy to use. Now you can explore current example to see
Microconfig
syntax,<br /> try out <a href="/plugin.html">IDE plugin</a> or deep dive into
<a href="/documentation.html">Docs</a>.</p>
</div>
</section>
</main>
<footer class="text-muted bg-light">
<div class="container footer-container">
<p class="copyright">Microconfig.io ©</p>
<div class="contacts">
<ul class="list-unstyled mb-0">
<li class="lead">Join our
<a
href="https://join.slack.com/t/microconfig/shared_invite/zt-dflf2m0n-wOPVfAmk5eiHPn_9Omff7Q">Slack!</a>
</li>
<li class="lead">Contribute on <a href="https://github.com/microconfig/microconfig">Github</a></li>
<li class="lead"><a href="mailto:hello@microconfig.io">hello@microconfig.io</a></li>
</ul>
</div>
</div>
</footer>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
<script src="vendor/bootstrap/bootstrap.bundle.min.js"></script>
<script src="vendor/prism/prism.js"></script>
</body>
</html>