├── .github
└── workflows
│ └── deploy.yml
├── .gitignore
├── LICENSE
├── README.md
└── pt
├── book.toml
├── src
├── BOOKSUMMARY.md
├── README.md
├── SUMMARY.md
└── day-1
│ └── README.md
└── theme
├── css
├── mdbook-admonish.css
└── style.css
└── index.hbs
/.github/workflows/deploy.yml:
--------------------------------------------------------------------------------
1 | name: Deploy
2 | on:
3 | push:
4 | branches:
5 | - main
6 |
7 | jobs:
8 | deploy:
9 | runs-on: ubuntu-latest
10 | permissions:
11 | contents: write # To push a branch
12 | pull-requests: write # To create a PR from that branch
13 | steps:
14 | - uses: actions/checkout@v3
15 | with:
16 | fetch-depth: 0
17 | - name: Install mdbook
18 | run: |
19 | mkdir mdbook
20 | curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.28/mdbook-v0.4.28-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
21 | curl -sSL https://github.com/tommilligan/mdbook-admonish/releases/download/v1.8.0/mdbook-admonish-v1.8.0-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
22 | echo `pwd`/mdbook >> $GITHUB_PATH
23 | - name: Deploy GitHub Pages
24 | run: |
25 | cd pt
26 | mdbook build
27 | git worktree add gh-pages
28 | git config user.name "Deploy from CI"
29 | git config user.email ""
30 | cd gh-pages
31 | # Delete the ref to avoid keeping history.
32 | git update-ref -d refs/heads/gh-pages
33 | rm -rf *
34 | mv ../book/* .
35 | git add .
36 | git commit -m "Deploy $GITHUB_SHA to gh-pages"
37 | git push --force --set-upstream origin gh-pages
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | book
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
66 |
67 | # Descomplicando ArgoCD - WIP
68 |
69 | ## Descrição
70 |
71 | Este repositório tem como objetivo descomplicar o uso do ArgoCD, bem como a utilização do GitOps.
72 |
73 | Esse repositório faz parte do projeto [Certified Containers Expert](https://github.com/badtuxx/CertifiedContainersExpert), onde o objetivo é preparar a pessoa para trabalhar com containers, não somente com uma tecnologia específica, mas sim com o conceito de containers e todas as ferramentas que são normalmente utilizadas nas melhores empresas de tecnologia do mundo.
74 |
75 |
76 |
77 |
78 | ## Conteúdo do repositório
79 | - [Descomplicando ArgoCD - WIP](pt/src/day-1/README.md#descomplicando-argocd---day-1)
80 | - [Day-1](pt/src/day-1/README.md#conteúdo-do-day-1)
81 | - [O que vamos aprender no Day-1?](pt/src/day-1/README.md#o-que-vamos-aprender-no-day-1)
82 | - [O que é o ArgoCD?](pt/src/day-1/README.md#o-que-é-o-argocd)
83 | - [O que é GitOps?](pt/src/day-1/README.md#o-que-é-gitops)
84 | - [Pré-requisitos](pt/src/day-1/README.md#pré-requisitos)
85 | - [Instalando o ArgoCD](pt/src/day-1/README.md#instalando-o-argocd)
86 | - [Instalando o ArgoCD como um operador no Kubernetes](pt/src/day-1/README.md#instalando-o-argocd-como-um-operador-no-kubernetes)
87 | - [Instalando o ArgoCD CLI](pt/src/day-1/README.md#instalando-o-argocd-cli)
88 | - [Autenticando no ArgoCD](pt/src/day-1/README.md#autenticando-no-argocd)
89 | - [Criando a aplicação no ArgoCD](pt/src/day-1/README.md#criando-a-aplicação-no-argocd)
90 | - [Criando a nossa app exemplo](pt/src/day-1/README.md#criando-a-nossa-app-exemplo)
91 | - [Criando a app no ArgoCD usando o ArgoCD CLI](pt/src/day-1/README.md#criando-a-app-no-argocd-usando-o-argocd-cli)
92 | - [Primeiros passos com o ArgoCD e nossa app](pt/src/day-1/README.md#primeiros-passos-com-o-argocd-e-nossa-app)
93 | - [Final Day-1](pt/src/day-1/README.md#final-day-1)
94 |
95 |
96 |
--------------------------------------------------------------------------------
/pt/book.toml:
--------------------------------------------------------------------------------
1 | [book]
2 | authors = ["LINUXtips"]
3 | language = "pt"
4 | multilingual = false
5 | src = "src"
6 | title = "Descomplicando ArgoCD"
7 |
8 | [output.html]
9 | git-repository-url = "https://github.com/badtuxx/DescomplicandoArgoCD"
10 | edit-url-template = "https://github.com/badtuxx/DescomplicandoArgoCD/edit/main/pt/{path}"
11 | additional-css = ["theme/css/style.css", "theme/css/mdbook-admonish.css"]
12 | cname = "CNAME"
13 |
14 | [output.html.search]
15 | limit-results = 20
16 | use-boolean-and = true
17 | boost-title = 2
18 | boost-hierarchy = 2
19 | boost-paragraph = 1
20 | expand = true
21 | heading-split-level = 2
22 |
23 | [preprocessor]
24 |
25 | [preprocessor.admonish]
26 | command = "mdbook-admonish"
27 | assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install`
--------------------------------------------------------------------------------
/pt/src/BOOKSUMMARY.md:
--------------------------------------------------------------------------------
1 |
2 | DAY-1
3 |
4 | ## Conteúdo do Day-1
5 | - [Descomplicando ArgoCD - DAY-1](day-1/index.html#descomplicando-argocd---day-1)
6 | - [O que vamos aprender no Day-1?](day-1/index.html#o-que-vamos-aprender-no-day-1)
7 | - [Conteúdo do Day-1](day-1/index.html#conteúdo-do-day-1)
8 | - [O que é o ArgoCD?](day-1/index.html#o-que-é-o-argocd)
9 | - [O que é GitOps?](day-1/index.html#o-que-é-gitops)
10 | - [Pré-requisitos](day-1/index.html#pré-requisitos)
11 | - [Instalando o ArgoCD](day-1/index.html#instalando-o-argocd)
12 | - [Instalando o ArgoCD como um operador no Kubernetes](day-1/index.html#instalando-o-argocd-como-um-operador-no-kubernetes)
13 | - [Instalando o ArgoCD CLI](day-1/index.html#instalando-o-argocd-cli)
14 | - [Autenticando no ArgoCD](day-1/index.html#autenticando-no-argocd)
15 | - [Criando a aplicação no ArgoCD](day-1/index.html#criando-a-aplicação-no-argocd)
16 | - [Criando a nossa app exemplo](day-1/index.html#criando-a-nossa-app-exemplo)
17 | - [Criando a app no ArgoCD usando o ArgoCD CLI](day-1/index.html#criando-a-app-no-argocd-usando-o-argocd-cli)
18 | - [Primeiros passos com o ArgoCD e nossa app](day-1/index.html#primeiros-passos-com-o-argocd-e-nossa-app)
19 | - [Final Day-1](day-1/index.html#final-day-1)
20 |
21 |
--------------------------------------------------------------------------------
/pt/src/README.md:
--------------------------------------------------------------------------------
1 | # Descomplicando ArgoCD - WIP
2 |
3 | ## Descrição
4 |
5 | Este repositório tem como objetivo descomplicar o uso do ArgoCD, bem como a utilização do GitOps.
6 |
7 | Esse repositório faz parte do projeto [Certified Containers Expert](https://github.com/badtuxx/CertifiedContainersExpert), onde o objetivo é preparar a pessoa para trabalhar com containers, não somente com uma tecnologia específica, mas sim com o conceito de containers e todas as ferramentas que são normalmente utilizadas nas melhores empresas de tecnologia do mundo.
8 |
9 |
--------------------------------------------------------------------------------
/pt/src/SUMMARY.md:
--------------------------------------------------------------------------------
1 | # SOBRE
2 |
3 | [Introdução](README.md)
4 |
5 | ---
6 |
7 | [Sumário](BOOKSUMMARY.md)
8 |
9 | ---
10 |
11 | # Capítulos
12 |
13 | - [Dia 1](day-1/README.md)
--------------------------------------------------------------------------------
/pt/src/day-1/README.md:
--------------------------------------------------------------------------------
1 | # Descomplicando ArgoCD - DAY-1
2 |
3 | ## O que vamos aprender no Day-1?
4 |
5 | Durante o day-1 iremos aprender o que é o ArgoCD, vamos entender o que é o GitOps e o que é estado desejado, vamos entender o que é um continuous delivery e como o ArgoCD pode nos ajudar a entregar nossas aplicações no Kubernetes de forma contínua e segura.
6 |
7 | Vamos ainda ver como instalar o nosso ArgoCD no Kubernetes como um operador, e também iremos instalar o ArgoCD CLI, que é a ferramenta que vamos utilizar para gerenciar as nossas aplicações no ArgoCD.
8 |
9 | Vamos adicionar o nosso cluster e criar a nossa primeira aplicação no ArgoCD, para que seja possível o deploy em nosso cluster.
10 |
11 | Enfim, muita coisa interessante para aprender no day-1, e para isso, vamos precisar de alguns pré-requisitos.
12 |
13 | - [ ] Ter um cluster Kubernetes rodando
14 | - [ ] Ter o kubectl instalado
15 | - [ ] Ter força de vontade para aprender
16 |
17 | Preencheu os pré-requisitos? Então vamos lá!
18 |
19 |
20 |
21 |
22 | ## Conteúdo do Day-1
23 | - [Descomplicando ArgoCD - DAY-1](#descomplicando-argocd---day-1)
24 | - [O que vamos aprender no Day-1?](#o-que-vamos-aprender-no-day-1)
25 | - [Conteúdo do Day-1](#conteúdo-do-day-1)
26 | - [O que é o ArgoCD?](#o-que-é-o-argocd)
27 | - [O que é GitOps?](#o-que-é-gitops)
28 | - [Pré-requisitos](#pré-requisitos)
29 | - [Instalando o ArgoCD](#instalando-o-argocd)
30 | - [Instalando o ArgoCD como um operador no Kubernetes](#instalando-o-argocd-como-um-operador-no-kubernetes)
31 | - [Instalando o ArgoCD CLI](#instalando-o-argocd-cli)
32 | - [Autenticando no ArgoCD](#autenticando-no-argocd)
33 | - [Criando a aplicação no ArgoCD](#criando-a-aplicação-no-argocd)
34 | - [Criando a nossa app exemplo](#criando-a-nossa-app-exemplo)
35 | - [Criando a app no ArgoCD usando o ArgoCD CLI](#criando-a-app-no-argocd-usando-o-argocd-cli)
36 | - [Primeiros passos com o ArgoCD e nossa app](#primeiros-passos-com-o-argocd-e-nossa-app)
37 | - [Final Day-1](#final-day-1)
38 |
39 |
40 |
41 | ## O que é o ArgoCD?
42 |
43 | O ArgoCD é uma poderoso ferramenta quando você pensa em GitOps ou Continous Delivery. O ArgoCD é um projeto open source, criado pela [Argo](https://argoproj.github.io/argo/), que tem como objetivo facilitar a implantação e gerenciamento de aplicações em Kubernetes.
44 |
45 | O ArgoCD foi escrito em Go e utiliza o [Kubernetes Operator Pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) para gerenciar os recursos do Kubernetes.
46 |
47 | Dito isso, fica claro que quando você instala o ArgoCD, você está instalando um operador do Kubernetes, que está extendendo o Kubernetes, adicionando novos `Custom Resources` e novos `Controllers` para gerenciar esses `Custom Resources`.
48 |
49 | Vamos ver isso com mais detalhes mais pra frente, mas por agora saiba que o ArgoCD vai mudar a forma como você pensa e trabalha com Kubernetes.
50 |
51 | Talvez esse seja somente o seu primeiro passo para o mundo do GitOps e do Continous Delivery, sim, entregas contínuas.
52 |
53 | Você e sua equipe terá que se adaptar e criar maturidade para trabalhar com entregas contínuas, pois entregar é a tarefa mais fácil, o difícil é entregar com qualidade e com segurança de que não vai quebrar nada, que foi testado e que não vai afetar o negócio.
54 |
55 | Um forte característica do ArgoCD é a sua separação de responsabilidades quando estamos falando de CI/CD. Ele não se preocupa em ser um solução completa para a sua esteira de CI/CD, ele se preocupa em ser uma ferramenta que vai gerenciar as entregas contínuas no Kubernetes, ele se preocupa com a parte CD, e não com a parte CI.
56 |
57 | Acho que essa é uma boa apresentação do ArgoCD, e nem vou vou precisar falar que ele é peça fundamental nas melhores engenharías de software do mundo.
58 |
59 | Está preparado para mais essa viajem com o objetivo de descomplicar mais um assunto, o ArgoCD?
60 |
61 | #VAIIII
62 |
63 |
64 | ## O que é GitOps?
65 |
66 | Esse livro não tem como objetivo descomplicar o GitOps. Nesse livro o nosso objetivo é descomplicar uma das etapas fundamentais do GitOps, que é a utilização do ArgoCD para gerenciar as entregas contínuas no Kubernetes.
67 |
68 | O GitOps é um conceito que foi criado pela [Weaveworks](https://www.weave.works/), e que tem como objetivo facilitar a entrega de aplicações no Kubernetes, utilizando o Git como fonte de verdade. O Git é a fonte de verdade, e o Git é o único lugar onde você vai encontrar a verdade sobre o estado da sua aplicação.
69 |
70 | Se lá é a fonte da verdade, vale a pena falar que quando estamos falando de GitOps, estamos falando sobre modo declarativo de gerenciar as aplicações no Kubernetes. Quando falamos em declarativo, estamos falando que o estado que das suas aplicação no Kubernetes, é o mesmo que está no Git, que é o mesmo que você deseja que esteja no Kubernetes.
71 |
72 | Confuso? Calma, eu te explico.
73 |
74 | Vamos imaginar que você tenha o seguinte arquivo no Git:
75 |
76 | ```yaml
77 | apiVersion: apps/v1 # versão da API
78 | kind: Deployment # tipo de recurso, no caso, um Deployment
79 | metadata: # metadados do recurso
80 | name: nginx-server # nome do recurso
81 | spec: # especificação do recurso
82 | selector: # seletor para identificar os pods que serão gerenciados pelo deployment
83 | matchLabels: # labels que identificam os pods que serão gerenciados pelo deployment
84 | app: nginx # label que identifica o app que será gerenciado pelo deployment
85 | replicas: 2 # quantidade de réplicas do deployment
86 | template: # template do deployment
87 | metadata: # metadados do template
88 | labels: # labels do template
89 | app: nginx # label que identifica o app
90 | annotations: # annotations do template
91 | prometheus.io/scrape: 'true' # habilita o scraping do Prometheus
92 | prometheus.io/port: '9113' # porta do target
93 | spec: # especificação do template
94 | containers: # containers do template
95 | - name: nginx # nome do container
96 | image: nginx # imagem do container do Nginx
97 | ports: # portas do container
98 | - containerPort: 80 # porta do container
99 | name: http # nome da porta
100 | volumeMounts: # volumes que serão montados no container
101 | - name: nginx-config # nome do volume
102 | mountPath: /etc/nginx/conf.d/default.conf # caminho de montagem do volume
103 | subPath: nginx.conf # subpath do volume
104 | - name: nginx-exporter # nome do container que será o exporter
105 | image: 'nginx/nginx-prometheus-exporter:0.11.0' # imagem do container do exporter
106 | args: # argumentos do container
107 | - '-nginx.scrape-uri=http://localhost/metrics' # argumento para definir a URI de scraping
108 | resources: # recursos do container
109 | limits: # limites de recursos
110 | memory: 128Mi # limite de memória
111 | cpu: 0.3 # limite de CPU
112 | ports: # portas do container
113 | - containerPort: 9113 # porta do container que será exposta
114 | name: metrics # nome da porta
115 | volumes: # volumes do template
116 | - configMap: # configmap do volume, nós iremos criar esse volume através de um configmap
117 | defaultMode: 420 # modo padrão do volume
118 | name: nginx-config # nome do configmap
119 | name: nginx-config # nome do volume
120 | ```
121 |
122 |
123 |
124 | Vamos dar o nome para esse arquivo de `nginx-deployment.yaml`.
125 |
126 | Esse arquivo é somente um manifesto do Kubernetes, onde estamos especificando um `Deployment` do Nginx, com 2 réplicas, onde o Nginx está exposto na porta 80, e o Prometheus está fazendo o scraping da porta 9113.
127 |
128 | Perceba, nesse arquivo estamos falando para o Kubernetes, que queremos que o Nginx esteja rodando com 2 réplicas, e que o Prometheus está fazendo o scraping da porta 9113, estamos declarando o estado desejado da nossa aplicação.
129 |
130 | Para aplicar esse arquivo no Kubernetes, basta executar o seguinte comando:
131 |
132 | ```bash
133 | kubectl apply -f nginx-deployment.yaml
134 | ```
135 |
136 |
137 |
138 | Vamos imaginar que por algum motivo precisamos mudar a quantidade de réplicas do Nginx para 3. Nós desejamos declarar o estado da nossa aplicação para 3 réplicas.
139 |
140 | Para isso, basta declarar, alterar a quantidade de réplicas do Nginx para 3 no arquivo `nginx-deployment.yaml`:
141 |
142 |
143 | ```yaml
144 | apiVersion: apps/v1 # versão da API
145 | kind: Deployment # tipo de recurso, no caso, um Deployment
146 | metadata: # metadados do recurso
147 | name: nginx-server # nome do recurso
148 | spec: # especificação do recurso
149 | selector: # seletor para identificar os pods que serão gerenciados pelo deployment
150 | matchLabels: # labels que identificam os pods que serão gerenciados pelo deployment
151 | app: nginx # label que identifica o app que será gerenciado pelo deployment
152 | replicas: 3 # quantidade de réplicas do deployment
153 | template: # template do deployment
154 | metadata: # metadados do template
155 | labels: # labels do template
156 | app: nginx # label que identifica o app
157 | annotations: # annotations do template
158 | prometheus.io/scrape: 'true' # habilita o scraping do Prometheus
159 | prometheus.io/port: '9113' # porta do target
160 | spec: # especificação do template
161 | containers: # containers do template
162 | - name: nginx # nome do container
163 | image: nginx # imagem do container do Nginx
164 | ports: # portas do container
165 | - containerPort: 80 # porta do container
166 | name: http # nome da porta
167 | volumeMounts: # volumes que serão montados no container
168 | - name: nginx-config # nome do volume
169 | mountPath: /etc/nginx/conf.d/default.conf # caminho de montagem do volume
170 | subPath: nginx.conf # subpath do volume
171 | - name: nginx-exporter # nome do container que será o exporter
172 | image: 'nginx/nginx-prometheus-exporter:0.11.0' # imagem do container do exporter
173 | args: # argumentos do container
174 | - '-nginx.scrape-uri=http://localhost/metrics' # argumento para definir a URI de scraping
175 | resources: # recursos do container
176 | limits: # limites de recursos
177 | memory: 128Mi # limite de memória
178 | cpu: 0.3 # limite de CPU
179 | ports: # portas do container
180 | - containerPort: 9113 # porta do container que será exposta
181 | name: metrics # nome da porta
182 | volumes: # volumes do template
183 | - configMap: # configmap do volume, nós iremos criar esse volume através de um configmap
184 | defaultMode: 420 # modo padrão do volume
185 | name: nginx-config # nome do configmap
186 | name: nginx-config # nome do volume
187 | ```
188 |
189 |
190 |
191 | Para que sua vonta seja aplicada, basta executar o seguinte comando:
192 |
193 | ```bash
194 | kubectl apply -f nginx-deployment.yaml
195 | ```
196 |
197 |
198 |
199 | Pronto, agora o Kubernetes sabe que você deseja que o Nginx esteja rodando com 3 réplicas e assim o fez.
200 |
201 | Isso é o que chamamos de **estado desejado**, estado que declaramos para o Kubernetes, e o Kubernetes mudou o estado atual para o estado desejado.
202 |
203 | Acredito que agora você tenha entendido um conceito muito importante do Kubernetes e no GitOps, que é o **estado desejado**.
204 |
205 | Se é importante para o GitOps, é importante para o ArgoCD, e é por isso que o ArgoCD trabalha com o conceito de **estado desejado**.
206 |
207 | Eu não vou entrar em muito detalhes aqui sobre o que é o GitOps, pois teremos um repo só para isso. Mas basicamente o GitOps é uma metodologia de gerenciamento de configurações, onde o Git é a única fonte de verdade, e o Git é o único responsável por declarar o estado desejado da aplicação.
208 |
209 |
210 |
211 | ## Pré-requisitos
212 |
213 | Para que possamos continuar daqui para frente, precisamos ter o seguinte instalado:
214 |
215 | - Um cluster Kubernetes
216 | - kubectl instalado
217 | - E muita vontade de aprender
218 |
219 | ## Instalando o ArgoCD
220 |
221 | Primeira coisa, como eu falei anteriormente, o ArgoCD é escrito em GO, o que nos ajuda demais no processo de instalação.
222 |
223 | Aqui precisamos dividir essa instalação em duas partes, a instalação do ArgoCD como um operador no Kubernetes, e a instalação do ArgoCD como CLI, para que você possa utilizar o ArgoCD no seu dia a dia.
224 |
225 | Ele possui ainda uma interface gráfica, que é o ArgoCD UI, mas não iremos abordar por enquanto, eu quero que a gente fique antes muito confortável com o ArgoCD CLI, que é o que iremos utilizar no nosso dia a dia.
226 |
227 | No começo ainda vamos utilizar somente o CLI, mas muito em breve vamos utilizar manifestos para definir as nossa aplicações dentro do ArgoCD.
228 |
229 |
230 |
231 | ### Instalando o ArgoCD como um operador no Kubernetes
232 |
233 | Para instalar o ArgoCD como um operador no Kubernetes, antes precisamos criar uma namespace chamada `argocd`, e para isso basta executar o seguinte comando:
234 |
235 | ```bash
236 | kubectl create namespace argocd
237 | ```
238 |
239 |
240 |
241 | A saída desse comando será algo parecido com isso:
242 |
243 | ```bash
244 | namespace/argocd created
245 | ```
246 |
247 | Agora vamos instalar o ArgoCD como um operador no Kubernetes:
248 |
249 | ```bash
250 | kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml
251 | ```
252 |
253 |
254 | A saída desse comando será algo parecido com isso:
255 |
256 | ```bash
257 | namespace/argocd created
258 | customresourcedefinition.apiextensions.k8s.io/applications.argoproj.io created
259 | customresourcedefinition.apiextensions.k8s.io/applicationsets.argoproj.io created
260 | customresourcedefinition.apiextensions.k8s.io/appprojects.argoproj.io created
261 | serviceaccount/argocd-application-controller created
262 | serviceaccount/argocd-applicationset-controller created
263 | serviceaccount/argocd-dex-server created
264 | serviceaccount/argocd-notifications-controller created
265 | serviceaccount/argocd-redis created
266 | serviceaccount/argocd-repo-server created
267 | serviceaccount/argocd-server created
268 | role.rbac.authorization.k8s.io/argocd-application-controller created
269 | role.rbac.authorization.k8s.io/argocd-applicationset-controller created
270 | role.rbac.authorization.k8s.io/argocd-dex-server created
271 | role.rbac.authorization.k8s.io/argocd-notifications-controller created
272 | role.rbac.authorization.k8s.io/argocd-server created
273 | clusterrole.rbac.authorization.k8s.io/argocd-application-controller created
274 | clusterrole.rbac.authorization.k8s.io/argocd-server created
275 | rolebinding.rbac.authorization.k8s.io/argocd-application-controller created
276 | rolebinding.rbac.authorization.k8s.io/argocd-applicationset-controller created
277 | rolebinding.rbac.authorization.k8s.io/argocd-dex-server created
278 | rolebinding.rbac.authorization.k8s.io/argocd-notifications-controller created
279 | rolebinding.rbac.authorization.k8s.io/argocd-redis created
280 | rolebinding.rbac.authorization.k8s.io/argocd-server created
281 | clusterrolebinding.rbac.authorization.k8s.io/argocd-application-controller created
282 | clusterrolebinding.rbac.authorization.k8s.io/argocd-server created
283 | configmap/argocd-cm created
284 | configmap/argocd-cmd-params-cm created
285 | configmap/argocd-gpg-keys-cm created
286 | configmap/argocd-notifications-cm created
287 | configmap/argocd-rbac-cm created
288 | configmap/argocd-ssh-known-hosts-cm created
289 | configmap/argocd-tls-certs-cm created
290 | secret/argocd-notifications-secret created
291 | secret/argocd-secret created
292 | service/argocd-applicationset-controller created
293 | service/argocd-dex-server created
294 | service/argocd-metrics created
295 | service/argocd-notifications-controller-metrics created
296 | service/argocd-redis created
297 | service/argocd-repo-server created
298 | service/argocd-server created
299 | service/argocd-server-metrics created
300 | deployment.apps/argocd-applicationset-controller created
301 | deployment.apps/argocd-dex-server created
302 | deployment.apps/argocd-notifications-controller created
303 | deployment.apps/argocd-redis created
304 | deployment.apps/argocd-repo-server created
305 | deployment.apps/argocd-server created
306 | statefulset.apps/argocd-application-controller created
307 | networkpolicy.networking.k8s.io/argocd-application-controller-network-policy created
308 | networkpolicy.networking.k8s.io/argocd-applicationset-controller-network-policy created
309 | networkpolicy.networking.k8s.io/argocd-dex-server-network-policy created
310 | networkpolicy.networking.k8s.io/argocd-notifications-controller-network-policy created
311 | networkpolicy.networking.k8s.io/argocd-redis-network-policy created
312 | networkpolicy.networking.k8s.io/argocd-repo-server-network-policy created
313 | networkpolicy.networking.k8s.io/argocd-server-network-policy created
314 | ```
315 |
316 |
317 |
318 | Como você pode ver, com o comando acima configuramos o ArgoCD através da criação de vários objetos no Kubernetes, como por exemplo, um `deployment` para o `argocd-server`, um `service` para o `argocd-server`, um `configmap` para o `argocd-cm`, e por aí vai.
319 |
320 | Caso você queira conhecer mais sobre o projeto, vá até o [repositório oficial](https://github.com/argoproj/argo-cd)
321 |
322 |
323 |
324 | Vamos ver se os pods do ArgoCD foram criados com sucesso:
325 |
326 | ```bash
327 | kubectl get pods -n argocd
328 | ```
329 |
330 |
331 |
332 | A saída desse comando será algo parecido com isso:
333 |
334 | ```bash
335 | NAME READY STATUS RESTARTS AGE
336 | argocd-application-controller-0 1/1 Running 0 115s
337 | argocd-applicationset-controller-5f67f4c987-vdtpr 1/1 Running 0 117s
338 | argocd-dex-server-5859d89dcc-c69fx 1/1 Running 0 117s
339 | argocd-notifications-controller-75c986587-7jznn 1/1 Running 0 116s
340 | argocd-redis-74c8c9c8c6-mzdlv 1/1 Running 0 116s
341 | argocd-repo-server-76f77874d7-8qscp 1/1 Running 0 116s
342 | argocd-server-64d5654c48-tkv65 1/1 Running 0 116s
343 | ```
344 |
345 |
346 |
347 | Onde temos os seguintes pods:
348 |
349 | * argocd-application-controller-0 - Responsável por gerenciar os recursos do Kubernetes
350 | * argocd-applicationset-controller-5f67f4c987-vdtpr - Controller responsável por gerenciar os `ApplicationSets`
351 | * argocd-dex-server-5859d89dcc-c69fx - Responsável por gerenciar a autenticação
352 | * argocd-notifications-controller-75c986587-7jznn - Responsável por gerenciar as notificações, como por exemplo, quando um `Application` é atualizado
353 | * argocd-redis-74c8c9c8c6-mzdlv - Responsável por armazenar os dados do ArgoCD
354 | * argocd-repo-server-76f77874d7-8qscp - Responsável por gerenciar os repositórios
355 | * argocd-server-64d5654c48-tkv65 - Responsável por expor a interface gráfica do ArgoCD
356 |
357 |
358 |
359 | Pronto, apresentados. No decorrer do livro iremos falar mais sobre cada um desses componentes, mas por agora é o que você precisa saber.
360 |
361 | Todos os nossos podes estão com o status `Running`, o que significa que eles estão funcionando corretamente.
362 |
363 |
364 |
365 | ## Instalando o ArgoCD CLI
366 |
367 | Como eu falei, o ArgoCD possui uma interface gráfica, mas também é possível interagir com ele através de comandos. Para isso, precisamos instalar o `argocd` CLI.
368 |
369 | Nós vamos focar a primeira parte desse livro no CLI, para que você consiga entender como funciona o ArgoCD por baixo dos panos, e depois sim, se delicie com a interface gráfica.
370 |
371 | Para instalar o `argocd` CLI no Linux, basta executar o seguinte comando:
372 |
373 | ```bash
374 | curl -sSL -o argocd-linux-amd64 https://github.com/argoproj/argo-cd/releases/latest/download/argocd-linux-amd64
375 |
376 | sudo install -m 555 argocd-linux-amd64 /usr/local/bin/argocd
377 |
378 | rm argocd-linux-amd64
379 | ```
380 |
381 |
382 |
383 | Com o comando acima fizemos o download do binário do `argocd` CLI, e o instalamos no diretório `/usr/local/bin/argocd`, para fazer a instalação utilizamos o comando `install` do Linux, que é um comando que faz a instalação de arquivos e diretórios. Passamos os parâmetros `-m 555` para definir as permissões do arquivo, e o nome do arquivo que queremos instalar.
384 |
385 | Pronto! O nosso `argocd` CLI está instalado.
386 |
387 | Vamos ver se ele está funcionando corretamente:
388 |
389 | ```bash
390 | argocd version
391 | ```
392 |
393 |
394 |
395 | Qual a versão do `argocd` CLI que você está utilizando? Comenta lá no Twitter e me marca para eu saber como está sendo essa sua abordagem com o ArgoCD. @badtux_, esse é o meu arroba lá no Twitter.
396 |
397 |
398 |
399 | ## Autenticando no ArgoCD
400 |
401 | Agora que já temos o ArgoCD instalado, tanto o CLI quanto o operador, precisamos fazer a autenticação no ArgoCD para que possamos dar os primeiros passos.
402 |
403 | Antes de mais nada, precisamos saber qual o endereço do ArgoCD. Para isso, vamos executar o seguinte comando:
404 |
405 | ```bash
406 | kubectl get svc -n argocd
407 | ```
408 |
409 |
410 |
411 | A saída desse comando será algo parecido com isso:
412 |
413 | ```bash
414 | NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
415 | argocd-applicationset-controller ClusterIP 10.100.164.34 7000/TCP,8080/TCP 12m
416 | argocd-dex-server ClusterIP 10.100.14.112 5556/TCP,5557/TCP,5558/TCP 12m
417 | argocd-metrics ClusterIP 10.100.146.115 8082/TCP 12m
418 | argocd-notifications-controller-metrics ClusterIP 10.100.81.159 9001/TCP 12m
419 | argocd-redis ClusterIP 10.100.174.178 6379/TCP 12m
420 | argocd-repo-server ClusterIP 10.100.148.141 8081/TCP,8084/TCP 12m
421 | argocd-server ClusterIP 10.100.25.239 80/TCP,443/TCP 12m
422 | argocd-server-metrics ClusterIP 10.100.46.64 8083/TCP 12m
423 | ```
424 |
425 |
426 |
427 | O service que precisamos por agora do ArgoCD é o `argocd-server`, e o endereço completo é `argocd-server.argocd.svc.cluster.local`.
428 |
429 | Vamos fazer o port-forward para acessar o ArgoCD sem precisar expor:
430 |
431 | ```bash
432 | kubectl port-forward svc/argocd-server -n argocd 8080:443
433 | ```
434 |
435 |
436 |
437 | Pronto, agora podemos acessar o ArgoCD através do endereço `localhost:8080`, tanto pelo navegador quanto pelo CLI.
438 |
439 | Vamos continuar com a nossa saga utilizando o CLI, então vamos fazer a autenticação no ArgoCD.
440 |
441 | Para fazer a autenticação no ArgoCD, precisamos executar o seguinte comando:
442 |
443 | ```bash
444 | argocd login localhost:8080
445 | ```
446 |
447 |
448 |
449 | Perceba que ele irá pedir o usuário e a senha, mas não se preocupe, pois o usuário padrão do ArgoCD é o `admin`, e a senha inicial está armazenada em um secret, então vamos executar o seguinte comando para pegar a senha:
450 |
451 | ```bash
452 | kubectl get secret argocd-initial-admin-secret -n argocd -o jsonpath="{.data.password}" | base64 -d
453 | ```
454 |
455 |
456 |
457 | A saída será a sua senha inicial, copie ela para que possamos utilizar no próximo comando:
458 |
459 | ```bash
460 | argocd login localhost:8080
461 | WARNING: server certificate had error: x509: certificate signed by unknown authority. Proceed insecurely (y/n)? y
462 | Username: admin
463 | Password:
464 | 'admin:login' logged in successfully
465 | Context 'localhost:8080' updated
466 | ```
467 |
468 |
469 |
470 | Pronto, estamos autenticados no ArgoCD. Agora vamos adicionar o nosso cluster Kubernetes ao ArgoCD.
471 |
472 | Para isso, vamos ver qual o contexto do nosso cluster Kubernetes:
473 |
474 | ```bash
475 | kubectl config current-context
476 | ```
477 |
478 |
479 |
480 | A saída será algo parecido com isso:
481 |
482 | ```bash
483 | girus@eks-cluster.us-east-1.eksctl.io
484 | ```
485 |
486 |
487 |
488 | Isso no meu caso que somente estou utilizando um cluster e é um EKS, lá da AWS.
489 |
490 | Agora vamos adicionar o nosso cluster ao ArgoCD:
491 |
492 | ```bash
493 | argocd cluster add O_NOME_DO_SEU_CONTEXT
494 | ```
495 |
496 |
497 |
498 | No meu caso:
499 |
500 | ```bash
501 | argocd cluster add girus@eks-cluster.us-east-1.eksctl.io
502 | ```
503 |
504 |
505 |
506 | A saída será algo parecido com isso:
507 |
508 | ```bash
509 | WARNING: This will create a service account `argocd-manager` on the cluster referenced by context `girus@eks-cluster.us-east-1.eksctl.io` with full cluster level privileges. Do you want to continue [y/N]? y
510 | INFO[0005] ServiceAccount "argocd-manager" created in namespace "kube-system"
511 | INFO[0005] ClusterRole "argocd-manager-role" created
512 | INFO[0005] ClusterRoleBinding "argocd-manager-role-binding" created
513 | Cluster 'https://F40E37CE91565CC520A53CB1B191CCCA.gr7.us-east-1.eks.amazonaws.com' added
514 | ```
515 |
516 |
517 |
518 | Caso esteja utilizando um cluster k8s no mesmo host em que está executando o kubectl, como é o que acontece quando usamos um cluster via kind ou minikube por exemplo, você pode ter o seguinte erro:
519 |
520 | ```bash
521 | WARNING: This will create a service account `argocd-manager` on the cluster referenced by context `kind-kind` with full cluster level privileges. Do you want to continue [y/N]? y
522 | INFO[0020] ServiceAccount "argocd-manager" created in namespace "kube-system"
523 | INFO[0020] ClusterRole "argocd-manager-role" created
524 | INFO[0020] ClusterRoleBinding "argocd-manager-role-binding" created
525 | INFO[0025] Created bearer token secret for ServiceAccount "argocd-manager"
526 | FATA[0025] rpc error: code = Unknown desc = Get "https://127.0.0.1:32919/version?timeout=32s": dial tcp 127.0.0.1:32919: connect: connection refused
527 | ```
528 |
529 | Para contornar esse erro execute o comando `kubectl get -n default endpoints`. A saída será algo parecido com isso:
530 |
531 | ```bash
532 | NAME ENDPOINTS AGE
533 | kubernetes 172.18.0.2:6443 103m
534 | ```
535 |
536 | Agora copie o ip e porta que foi mostrado com a execução do comando anterior e altere somente o valor de endereço do server no seu arquivo `.kube/config`, como no exemplo abaixo onde o ip antigo foi comentado e o novo endereço foi configurado:
537 |
538 | ```yaml
539 | apiVersion: v1
540 | clusters:
541 | - cluster:
542 | #server: https://127.0.0.1:32919
543 | server: https://172.18.0.2:6443
544 | name: kind-kind
545 |
546 | ```
547 |
548 |
549 | Após essa modificação execute novamente o comando para adicionar o cluster ao ArgoCD
550 |
551 | ```bash
552 | argocd cluster add O_NOME_DO_SEU_CONTEXT
553 | ```
554 |
555 | E desta vez a saída sem erro será parecida com isso:
556 |
557 | ```bash
558 | WARNING: This will create a service account `argocd-manager` on the cluster referenced by context `kind-kind` with full cluster level privileges. Do you want to continue [y/N]? y
559 | INFO[0001] ServiceAccount "argocd-manager" already exists in namespace "kube-system"
560 | INFO[0001] ClusterRole "argocd-manager-role" updated
561 | INFO[0001] ClusterRoleBinding "argocd-manager-role-binding" updated
562 | Cluster 'https://172.18.0.2:6443' added
563 | ```
564 |
565 |
566 |
567 | Pronto, nosso cluster foi adicionado ao ArgoCD.
568 |
569 | Vamos confirmar se o nosso cluster foi adicionado ao ArgoCD:
570 |
571 | ```bash
572 | argocd cluster list
573 | ```
574 |
575 | A saída será algo parecido com isso:
576 |
577 | ```bash
578 | SERVER NAME VERSION STATUS MESSAGE PROJECT
579 | https://F40E37CE91565CC520A53CB1B191CCCA.gr7.us-east-1.eks.amazonaws.com girus@eks-cluster.us-east-1.eksctl.io Unknown Cluster has no applications and is not being monitored.
580 | https://kubernetes.default.svc in-cluster Unknown Cluster has no applications and is not being monitored.
581 | ```
582 |
583 |
584 |
585 | Na saída, temos o nosso cluster adicionado, e o cluster local, que é o `in-cluster`, que vem por padrão.
586 |
587 |
588 |
589 | Pronto, já temos onde a nossa aplicação vai ser implantada, agora vamos criar a nossa aplicação para o ArgoCD.
590 |
591 |
592 |
593 | ## Criando a aplicação no ArgoCD
594 |
595 | Agora que já temos o nosso cluster adicionado ao ArgoCD, vamos criar a nossa aplicação. Para isso, temos que ter um repositório Git com o nosso código, e o ArgoCD vai monitorar esse repositório e vai fazer o deploy da nossa aplicação sempre que tiver uma alteração.
596 |
597 | ### Criando a nossa app exemplo
598 |
599 | Para o nosso exemplo, vamos utilizar um repo que criem no GitHub, e o código está disponível [aqui](https://github.com/badtuxx/k8s-deploy-nginx-example).
600 |
601 | Eu criei esse repo somente para servir de exemplo para essa nossa primeira parte. O que temos nesse repo são somente quatro arquivos, um que define o nosso `Deployment`, outro que define o nosso `Service`, temos um que define um `ConfigMap` e outro que define um `Pod`.
602 |
603 | O nosso `Deployment` é bem simples, ele cria um `Pod` com dois containers, um que é o `nginx` e outro que é o `nginx-exporter`, que é um container que vai expor as métricas do nginx para o Prometheus.
604 |
605 | O nosso `Service` é bem simples também, ele expõe a porta `9113` do nosso `Pod`, que é a porta que o `nginx-exporter`.
606 |
607 | Já o nosso `ConfigMap` é um `ConfigMap` que terá a configuração default do nginx, que é o `default.conf`.
608 |
609 | Os arquivos são esses:
610 |
611 | * nginx-deployment.yaml
612 |
613 | ```yaml
614 | apiVersion: apps/v1 # versão da API
615 | kind: Deployment # tipo de recurso, no caso, um Deployment
616 | metadata: # metadados do recurso
617 | name: nginx-server # nome do recurso
618 | spec: # especificação do recurso
619 | selector: # seletor para identificar os pods que serão gerenciados pelo deployment
620 | matchLabels: # labels que identificam os pods que serão gerenciados pelo deployment
621 | app: nginx # label que identifica o app que será gerenciado pelo deployment
622 | replicas: 2 # quantidade de réplicas do deployment
623 | template: # template do deployment
624 | metadata: # metadados do template
625 | labels: # labels do template
626 | app: nginx # label que identifica o app
627 | annotations: # annotations do template
628 | prometheus.io/scrape: 'true' # habilita o scraping do Prometheus
629 | prometheus.io/port: '9113' # porta do target
630 | spec: # especificação do template
631 | containers: # containers do template
632 | - name: nginx # nome do container
633 | image: nginx # imagem do container do Nginx
634 | ports: # portas do container
635 | - containerPort: 80 # porta do container
636 | name: http # nome da porta
637 | volumeMounts: # volumes que serão montados no container
638 | - name: nginx-config # nome do volume
639 | mountPath: /etc/nginx/conf.d/default.conf # caminho de montagem do volume
640 | subPath: nginx.conf # subpath do volume
641 | - name: nginx-exporter # nome do container que será o exporter
642 | image: 'nginx/nginx-prometheus-exporter:0.11.0' # imagem do container do exporter
643 | args: # argumentos do container
644 | - '-nginx.scrape-uri=http://localhost/metrics' # argumento para definir a URI de scraping
645 | resources: # recursos do container
646 | limits: # limites de recursos
647 | memory: 128Mi # limite de memória
648 | cpu: 0.3 # limite de CPU
649 | ports: # portas do container
650 | - containerPort: 9113 # porta do container que será exposta
651 | name: metrics # nome da porta
652 | volumes: # volumes do template
653 | - configMap: # configmap do volume, nós iremos criar esse volume através de um configmap
654 | defaultMode: 420 # modo padrão do volume
655 | name: nginx-config # nome do configmap
656 | name: nginx-config # nome do volume
657 | ```
658 |
659 |
660 |
661 | * nginx-service.yaml
662 |
663 | ```yaml
664 | apiVersion: v1 # versão da API
665 | kind: Service # tipo de recurso, no caso, um Service
666 | metadata: # metadados do recurso
667 | name: nginx-svc # nome do recurso
668 | labels: # labels do recurso
669 | app: nginx # label para identificar o svc
670 | spec: # especificação do recurso
671 | ports: # definição da porta do svc
672 | - port: 9113 # porta do svc
673 | name: metrics # nome da porta
674 | selector: # seletor para identificar os pods/deployment que esse svc irá expor
675 | app: nginx # label que identifica o pod/deployment que será exposto
676 | ```
677 |
678 |
679 |
680 | * nginx-configmap.yaml
681 |
682 | ```yaml
683 | apiVersion: v1 # versão da API
684 | kind: ConfigMap # tipo de recurso, no caso, um ConfigMap
685 | metadata: # metadados do recurso
686 | name: nginx-config # nome do recurso
687 | data: # dados do recurso
688 | nginx.conf: | # inicio da definição do arquivo de configuração do Nginx
689 | server {
690 | listen 80;
691 | location / {
692 | root /usr/share/nginx/html;
693 | index index.html index.htm;
694 | }
695 | location /metrics {
696 | stub_status on;
697 | access_log off;
698 | }
699 | }
700 | ```
701 |
702 |
703 |
704 | * nginx-pod.yaml
705 |
706 | ```yaml
707 | apiVersion: v1
708 | kind: Pod
709 | metadata:
710 | name: nginx-pod
711 | labels:
712 | app: nginx
713 | spec:
714 | containers: # containers do template
715 | - name: nginx-container # nome do container
716 | image: nginx # imagem do container do Nginx
717 | ports: # portas do container
718 | - containerPort: 80 # porta do container
719 | name: http # nome da porta
720 | volumeMounts: # volumes que serão montados no container
721 | - name: nginx-config # nome do volume
722 | mountPath: /etc/nginx/conf.d/default.conf # caminho de montagem do volume
723 | subPath: nginx.conf # subpath do volume
724 | - name: nginx-exporter # nome do container que será o exporter
725 | image: 'nginx/nginx-prometheus-exporter:0.11.0' # imagem do container do exporter
726 | args: # argumentos do container
727 | - '-nginx.scrape-uri=http://localhost/metrics' # argumento para definir a URI de scraping
728 | resources: # recursos do container
729 | limits: # limites de recursos
730 | memory: 128Mi # limite de memória
731 | cpu: 0.3 # limite de CPU
732 | ports: # portas do container
733 | - containerPort: 9113 # porta do container que será exposta
734 | name: metrics # nome da porta
735 | volumes: # volumes do template
736 | - configMap: # configmap do volume, nós iremos criar esse volume através de um configmap
737 | defaultMode: 420 # modo padrão do volume
738 | name: nginx-config # nome do configmap
739 | name: nginx-config # nome do volume
740 | ```
741 |
742 |
743 |
744 | Pronto, explicado o que temos nesse repo. Basicamente quatro manifestos que irão criar um `Deployment` com dois `Pods`, um `Service`, um `ConfigMap`, além de um `Pod`solto.
745 |
746 | A mágica que queremos aqui é fazer com que o ArgoCD faça o deploy do nosso `Deployment` e `Service` e tudo mais que está no nosso repo, mas para isso precisamos criar um `Application` que irá fazer o deploy do nosso `Deployment` e `Service`.
747 |
748 | ### Criando a app no ArgoCD usando o ArgoCD CLI
749 |
750 | Já sabemos o que queremos ter em nosso cluster, agora bora criar a nossa aplicação no ArgoCD com o seguinte comando:
751 |
752 | ```bash
753 | argocd app create nginx-app --repo https://github.com/badtuxx/k8s-deploy-nginx-example.git --path . --dest-server https://F40E37CE91565CC520A53CB1B191CCCA.gr7.us-east-1.eks.amazonaws.com --dest-namespace default
754 | ```
755 |
756 |
757 |
758 |
759 | Onde:
760 | * `nginx-app` é o nome da nossa aplicação
761 | * `repo` é o repo onde está o nosso código
762 | * `path` é o caminho onde está o nosso código
763 | * `dest-server` é o cluster onde queremos fazer o deploy
764 | * `dest-namespace` é o namespace onde queremos fazer o deploy
765 |
766 | A saída do comando será algo como:
767 |
768 | ```bash
769 | Application 'nginx-app' created
770 | ```
771 |
772 |
773 |
774 | ### Primeiros passos com o ArgoCD e nossa app
775 |
776 | Agora vamos ver se o nosso `Application` foi criado com sucesso:
777 |
778 | ```bash
779 | argocd app list
780 | ```
781 |
782 |
783 |
784 | A saída do comando será algo como:
785 |
786 | ```bash
787 | NAME CLUSTER NAMESPACE PROJECT STATUS HEALTH SYNCPOLICY CONDITIONS REPO PATH TARGET
788 | argocd/nginx-app https://F40E37CE91565CC520A53CB1B191CCCA.gr7.us-east-1.eks.amazonaws.com default default OutOfSync Missing https://github.com/badtuxx/k8s-deploy-nginx-example.git .
789 | ```
790 |
791 |
792 |
793 | Agora vamos ver o que está acontecendo com o nosso `Application`:
794 |
795 | ```bash
796 | argocd app get nginx-app
797 | ```
798 |
799 |
800 |
801 | Ele irá retornar algo como:
802 |
803 | ```bash
804 | Name: argocd/nginx-app
805 | Project: default
806 | Server: https://F40E37CE91565CC520A53CB1B191CCCA.gr7.us-east-1.eks.amazonaws.com
807 | Namespace: default
808 | URL: https://localhost:8080/applications/nginx-app
809 | Repo: https://github.com/badtuxx/k8s-deploy-nginx-example.git
810 | Target:
811 | Path: .
812 | SyncWindow: Sync Allowed
813 | Sync Policy:
814 | Sync Status: OutOfSync from (18397fa)
815 | Health Status: Missing
816 |
817 | GROUP KIND NAMESPACE NAME STATUS HEALTH HOOK MESSAGE
818 | ConfigMap default nginx-config OutOfSync Missing
819 | Pod default nginx-pod OutOfSync Missing
820 | Service default nginx-svc OutOfSync Missing
821 | apps Deployment default nginx-server OutOfSync Missing
822 | ```
823 |
824 |
825 |
826 | Duas informações importantes aqui:
827 |
828 | * O `Application` está com o status `OutOfSync` e o `Sync Status` também está `OutOfSync`;
829 | * O `Application` está com o status `Missing` e o `Health Status` também está `Missing`.
830 |
831 |
832 |
833 | Precisa de mais alguma informação? Vamos ver o que o ArgoCD está tentando fazer:
834 |
835 | ```bash
836 | argocd app logs nginx-app
837 | ```
838 |
839 |
840 |
841 | Ainda não temos nada, pois o ArgoCD ainda não fez nada, pois o nosso `Application` está com o status `OutOfSync` e o `Sync Status` também está `OutOfSync`, então precisamos fazer o sync do nosso `Application` para que o ArgoCD possa fazer o deploy do nosso `Deployment` e `Service`:
842 |
843 | ```bash
844 | argocd app sync nginx-app
845 | ```
846 |
847 |
848 |
849 | A saída do comando será algo como:
850 |
851 | ```bash
852 | TIMESTAMP GROUP KIND NAMESPACE NAME STATUS HEALTH HOOK MESSAGE
853 | 2023-03-05T19:04:16+01:00 ConfigMap default nginx-config OutOfSync Missing
854 | 2023-03-05T19:04:16+01:00 Pod default nginx-pod OutOfSync Missing
855 | 2023-03-05T19:04:16+01:00 Service default nginx-svc OutOfSync Missing
856 | 2023-03-05T19:04:16+01:00 apps Deployment default nginx-server OutOfSync Missing
857 | 2023-03-05T19:04:17+01:00 ConfigMap default nginx-config Synced Missing
858 | 2023-03-05T19:04:17+01:00 Service default nginx-svc Synced Healthy
859 | 2023-03-05T19:04:17+01:00 ConfigMap default nginx-config Synced Missing configmap/nginx-config created
860 | 2023-03-05T19:04:17+01:00 Service default nginx-svc Synced Healthy service/nginx-svc created
861 | 2023-03-05T19:04:17+01:00 Pod default nginx-pod OutOfSync Missing pod/nginx-pod created
862 | 2023-03-05T19:04:17+01:00 apps Deployment default nginx-server OutOfSync Missing deployment.apps/nginx-server created
863 | 2023-03-05T19:04:17+01:00 Pod default nginx-pod Synced Progressing pod/nginx-pod created
864 | 2023-03-05T19:04:17+01:00 apps Deployment default nginx-server Synced Progressing deployment.apps/nginx-server created
865 |
866 | Name: argocd/nginx-app
867 | Project: default
868 | Server: https://F40E37CE91565CC520A53CB1B191CCCA.gr7.us-east-1.eks.amazonaws.com
869 | Namespace: default
870 | URL: https://localhost:8080/applications/nginx-app
871 | Repo: https://github.com/badtuxx/k8s-deploy-nginx-example.git
872 | Target:
873 | Path: .
874 | SyncWindow: Sync Allowed
875 | Sync Policy:
876 | Sync Status: Synced to (18397fa)
877 | Health Status: Progressing
878 |
879 | Operation: Sync
880 | Sync Revision: 18397faeb8c9f6a10a63d3091d8021655778db7c
881 | Phase: Succeeded
882 | Start: 2023-03-05 19:04:15 +0100 CET
883 | Finished: 2023-03-05 19:04:17 +0100 CET
884 | Duration: 2s
885 | Message: successfully synced (all tasks run)
886 |
887 | GROUP KIND NAMESPACE NAME STATUS HEALTH HOOK MESSAGE
888 | ConfigMap default nginx-config Synced configmap/nginx-config created
889 | Service default nginx-svc Synced Healthy service/nginx-svc created
890 | Pod default nginx-pod Synced Progressing pod/nginx-pod created
891 | apps Deployment default nginx-server Synced Progressing deployment.apps/nginx-server created
892 | ```
893 |
894 |
895 |
896 | Preste atenção nessa parte aqui:
897 |
898 | ```bash
899 | GROUP KIND NAMESPACE NAME STATUS HEALTH HOOK MESSAGE
900 | ConfigMap default nginx-config Synced configmap/nginx-config created
901 | Service default nginx-svc Synced Healthy service/nginx-svc created
902 | Pod default nginx-pod Synced Progressing pod/nginx-pod created
903 | apps Deployment default nginx-server Synced Progressing deployment.apps/nginx-server created
904 | ```
905 |
906 |
907 |
908 | Aqui ele está dizendo que o `ConfigMap` foi criado, o `Service` foi criado, o `Pod` foi criado e o `Deployment` foi criado. Parece que está tudo certo, certo?
909 |
910 | Vamos ver se ele criou algo no Kubernetes:
911 |
912 | ```bash
913 | kubectl get pods
914 | ```
915 |
916 |
917 |
918 | Parece que sim hein?
919 |
920 | ```bash
921 | NAME READY STATUS RESTARTS AGE
922 | nginx-pod 2/2 Running 0 2m14s
923 | nginx-server-6949f64b59-jc7pj 2/2 Running 0 2m14s
924 | nginx-server-6949f64b59-l42zn 2/2 Running 0 2m14s
925 | ```
926 |
927 |
928 |
929 | Agora vamos ver se o `Service` está funcionando:
930 |
931 | ```bash
932 | kubectl get svc
933 | ```
934 |
935 |
936 |
937 | ```bash
938 | NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
939 | kubernetes ClusterIP 10.100.0.1 443/TCP 59m
940 | nginx-svc ClusterIP 10.100.146.231 9113/TCP 2m40s
941 | ```
942 |
943 |
944 |
945 | Somente falta ver se o `ConfigMap` foi criado:
946 |
947 | ```bash
948 | kubectl get cm
949 | ```
950 |
951 |
952 |
953 | ```bash
954 | NAME DATA AGE
955 | kube-root-ca.crt 1 60m
956 | nginx-config 1 3m13s
957 | ```
958 |
959 |
960 |
961 | Pronto, tudo funcionando.
962 |
963 | Bora ver novamente o status do nosso `Application`:
964 |
965 | ```bash
966 | argocd app get nginx-app
967 | ```
968 |
969 |
970 |
971 | ```bash
972 | Name: argocd/nginx-app
973 | Project: default
974 | Server: https://F40E37CE91565CC520A53CB1B191CCCA.gr7.us-east-1.eks.amazonaws.com
975 | Namespace: default
976 | URL: https://localhost:8080/applications/nginx-app
977 | Repo: https://github.com/badtuxx/k8s-deploy-nginx-example.git
978 | Target:
979 | Path: .
980 | SyncWindow: Sync Allowed
981 | Sync Policy:
982 | Sync Status: Synced to (18397fa)
983 | Health Status: Healthy
984 |
985 | GROUP KIND NAMESPACE NAME STATUS HEALTH HOOK MESSAGE
986 | ConfigMap default nginx-config Synced configmap/nginx-config created
987 | Service default nginx-svc Synced Healthy service/nginx-svc created
988 | Pod default nginx-pod Synced Healthy pod/nginx-pod created
989 | apps Deployment default nginx-server Synced Healthy deployment.apps/nginx-server created
990 | ```
991 |
992 |
993 |
994 | Tudo está `Synced` e `Healthy`.
995 |
996 | E os logs?
997 |
998 | ```bash
999 | argocd app logs nginx-app --container nginx
1000 | ```
1001 |
1002 |
1003 |
1004 | ```bash
1005 | /docker-entrypoint.sh: Configuration complete; ready for start up
1006 | 2023/03/05 18:04:22 [notice] 1#1: using the "epoll" event method
1007 | 2023/03/05 18:04:22 [notice] 1#1: nginx/1.23.3
1008 | 2023/03/05 18:04:22 [notice] 1#1: built by gcc 10.2.1 20210110 (Debian 10.2.1-6)
1009 | 2023/03/05 18:04:22 [notice] 1#1: OS: Linux 5.4.228-132.418.amzn2.x86_64
1010 | 2023/03/05 18:04:22 [notice] 1#1: getrlimit(RLIMIT_NOFILE): 1048576:1048576
1011 | 2023/03/05 18:04:22 [notice] 1#1: start worker processes
1012 | 2023/03/05 18:04:22 [notice] 1#1: start worker process 21
1013 | 2023/03/05 18:04:22 [notice] 1#1: start worker process 22
1014 | ```
1015 |
1016 |
1017 |
1018 | O que ele faz é trazer o log do container `nginx` do pod `nginx-pod` que foi criado pelo `Deployment` `nginx-server`, mesma coisa que se você tivesse feito:
1019 |
1020 | ```bash
1021 | kubectl logs -f nginx-pod -c nginx
1022 | ```
1023 |
1024 |
1025 |
1026 | Simples demais!
1027 |
1028 |
1029 |
1030 | Vamos recapitular os comandos do ArgoCD:
1031 |
1032 | ```bash
1033 | argocd login localhost:8080 # Faz o login no ArgoCD
1034 | argocd add cluster NOME_DO_SEU_CONTEXT # Adiciona um cluster ao ArgoCD
1035 | argocd app create nginx-app --repo https://github.com/badtuxx/k8s-deploy-nginx-example.git --path . --dest-server NOME_DO_SEU_CONTEXT --dest-namespace default
1036 | argocd app list # Lista os aplicativos
1037 | argocd app get nginx-app # Mostra o status do aplicativo
1038 | argocd app logs nginx-app --container nginx # Mostra os logs do aplicativo
1039 | argocd app sync nginx-app # Sincroniza o aplicativo com o repositório
1040 | ```
1041 |
1042 |
1043 |
1044 |
1045 | ## Final Day-1
1046 |
1047 | Acho que é o que precisamos para o nosso primeiro dia de trabalho com o ArgoCD. Durante o dia de hoje você aprendeu:
1048 | * Como instalar o ArgoCD no Kubernetes
1049 | * Como autenticar no ArgoCD
1050 | * Como adicionar um cluster ao ArgoCD
1051 | * Os detalhes de como criar um deployment, service e configmap no Kubernetes
1052 | * Como criar um aplicativo no ArgoCD
1053 | * Como sincronizar um aplicativo no ArgoCD
1054 | * Como ver o status de um aplicativo no ArgoCD
1055 | * Como ver os logs de um aplicativo no ArgoCD
--------------------------------------------------------------------------------
/pt/theme/css/mdbook-admonish.css:
--------------------------------------------------------------------------------
1 | @charset "UTF-8";
2 | :root {
3 | --md-admonition-icon--note:
4 | url("data:image/svg+xml;charset=utf-8,");
5 | --md-admonition-icon--abstract:
6 | url("data:image/svg+xml;charset=utf-8,");
7 | --md-admonition-icon--info:
8 | url("data:image/svg+xml;charset=utf-8,");
9 | --md-admonition-icon--tip:
10 | url("data:image/svg+xml;charset=utf-8,");
11 | --md-admonition-icon--success:
12 | url("data:image/svg+xml;charset=utf-8,");
13 | --md-admonition-icon--question:
14 | url("data:image/svg+xml;charset=utf-8,");
15 | --md-admonition-icon--warning:
16 | url("data:image/svg+xml;charset=utf-8,");
17 | --md-admonition-icon--failure:
18 | url("data:image/svg+xml;charset=utf-8,");
19 | --md-admonition-icon--danger:
20 | url("data:image/svg+xml;charset=utf-8,");
21 | --md-admonition-icon--bug:
22 | url("data:image/svg+xml;charset=utf-8,");
23 | --md-admonition-icon--example:
24 | url("data:image/svg+xml;charset=utf-8,");
25 | --md-admonition-icon--quote:
26 | url("data:image/svg+xml;charset=utf-8,");
27 | --md-details-icon:
28 | url("data:image/svg+xml;charset=utf-8,");
29 | }
30 |
31 | :is(.admonition) {
32 | display: flow-root;
33 | margin: 1.5625em 0;
34 | padding: 0 1.2rem;
35 | color: var(--fg);
36 | page-break-inside: avoid;
37 | background-color: var(--bg);
38 | border: 0 solid black;
39 | border-inline-start-width: 0.4rem;
40 | border-radius: 0.2rem;
41 | box-shadow: 0 0.2rem 1rem rgba(0, 0, 0, 0.05), 0 0 0.1rem rgba(0, 0, 0, 0.1);
42 | }
43 | @media print {
44 | :is(.admonition) {
45 | box-shadow: none;
46 | }
47 | }
48 | :is(.admonition) > * {
49 | box-sizing: border-box;
50 | }
51 | :is(.admonition) :is(.admonition) {
52 | margin-top: 1em;
53 | margin-bottom: 1em;
54 | }
55 | :is(.admonition) > .tabbed-set:only-child {
56 | margin-top: 0;
57 | }
58 | html :is(.admonition) > :last-child {
59 | margin-bottom: 1.2rem;
60 | }
61 |
62 | a.admonition-anchor-link {
63 | display: none;
64 | position: absolute;
65 | left: -1.2rem;
66 | padding-right: 1rem;
67 | }
68 | a.admonition-anchor-link:link, a.admonition-anchor-link:visited {
69 | color: var(--fg);
70 | }
71 | a.admonition-anchor-link:link:hover, a.admonition-anchor-link:visited:hover {
72 | text-decoration: none;
73 | }
74 | a.admonition-anchor-link::before {
75 | content: "§";
76 | }
77 |
78 | :is(.admonition-title, summary) {
79 | position: relative;
80 | margin-block: 0;
81 | margin-inline: -1.6rem -1.2rem;
82 | padding-block: 0.8rem;
83 | padding-inline: 4.4rem 1.2rem;
84 | font-weight: 700;
85 | background-color: rgba(68, 138, 255, 0.1);
86 | display: flex;
87 | }
88 | :is(.admonition-title, summary) p {
89 | margin: 0;
90 | }
91 | html :is(.admonition-title, summary):last-child {
92 | margin-bottom: 0;
93 | }
94 | :is(.admonition-title, summary)::before {
95 | position: absolute;
96 | top: 0.625em;
97 | inset-inline-start: 1.6rem;
98 | width: 2rem;
99 | height: 2rem;
100 | background-color: #448aff;
101 | mask-image: url('data:image/svg+xml;charset=utf-8,');
102 | -webkit-mask-image: url('data:image/svg+xml;charset=utf-8,');
103 | mask-repeat: no-repeat;
104 | -webkit-mask-repeat: no-repeat;
105 | mask-size: contain;
106 | -webkit-mask-size: contain;
107 | content: "";
108 | }
109 | :is(.admonition-title, summary):hover a.admonition-anchor-link {
110 | display: initial;
111 | }
112 |
113 | details.admonition > summary.admonition-title::after {
114 | position: absolute;
115 | top: 0.625em;
116 | inset-inline-end: 1.6rem;
117 | height: 2rem;
118 | width: 2rem;
119 | background-color: currentcolor;
120 | mask-image: var(--md-details-icon);
121 | -webkit-mask-image: var(--md-details-icon);
122 | mask-repeat: no-repeat;
123 | -webkit-mask-repeat: no-repeat;
124 | mask-size: contain;
125 | -webkit-mask-size: contain;
126 | content: "";
127 | transform: rotate(0deg);
128 | transition: transform 0.25s;
129 | }
130 | details[open].admonition > summary.admonition-title::after {
131 | transform: rotate(90deg);
132 | }
133 |
134 | :is(.admonition):is(.note) {
135 | border-color: #448aff;
136 | }
137 |
138 | :is(.note) > :is(.admonition-title, summary) {
139 | background-color: rgba(68, 138, 255, 0.1);
140 | }
141 | :is(.note) > :is(.admonition-title, summary)::before {
142 | background-color: #448aff;
143 | mask-image: var(--md-admonition-icon--note);
144 | -webkit-mask-image: var(--md-admonition-icon--note);
145 | mask-repeat: no-repeat;
146 | -webkit-mask-repeat: no-repeat;
147 | mask-size: contain;
148 | -webkit-mask-repeat: no-repeat;
149 | }
150 |
151 | :is(.admonition):is(.abstract, .summary, .tldr) {
152 | border-color: #00b0ff;
153 | }
154 |
155 | :is(.abstract, .summary, .tldr) > :is(.admonition-title, summary) {
156 | background-color: rgba(0, 176, 255, 0.1);
157 | }
158 | :is(.abstract, .summary, .tldr) > :is(.admonition-title, summary)::before {
159 | background-color: #00b0ff;
160 | mask-image: var(--md-admonition-icon--abstract);
161 | -webkit-mask-image: var(--md-admonition-icon--abstract);
162 | mask-repeat: no-repeat;
163 | -webkit-mask-repeat: no-repeat;
164 | mask-size: contain;
165 | -webkit-mask-repeat: no-repeat;
166 | }
167 |
168 | :is(.admonition):is(.info, .todo) {
169 | border-color: #00b8d4;
170 | }
171 |
172 | :is(.info, .todo) > :is(.admonition-title, summary) {
173 | background-color: rgba(0, 184, 212, 0.1);
174 | }
175 | :is(.info, .todo) > :is(.admonition-title, summary)::before {
176 | background-color: #00b8d4;
177 | mask-image: var(--md-admonition-icon--info);
178 | -webkit-mask-image: var(--md-admonition-icon--info);
179 | mask-repeat: no-repeat;
180 | -webkit-mask-repeat: no-repeat;
181 | mask-size: contain;
182 | -webkit-mask-repeat: no-repeat;
183 | }
184 |
185 | :is(.admonition):is(.tip, .hint, .important) {
186 | border-color: #00bfa5;
187 | }
188 |
189 | :is(.tip, .hint, .important) > :is(.admonition-title, summary) {
190 | background-color: rgba(0, 191, 165, 0.1);
191 | }
192 | :is(.tip, .hint, .important) > :is(.admonition-title, summary)::before {
193 | background-color: #00bfa5;
194 | mask-image: var(--md-admonition-icon--tip);
195 | -webkit-mask-image: var(--md-admonition-icon--tip);
196 | mask-repeat: no-repeat;
197 | -webkit-mask-repeat: no-repeat;
198 | mask-size: contain;
199 | -webkit-mask-repeat: no-repeat;
200 | }
201 |
202 | :is(.admonition):is(.success, .check, .done) {
203 | border-color: #00c853;
204 | }
205 |
206 | :is(.success, .check, .done) > :is(.admonition-title, summary) {
207 | background-color: rgba(0, 200, 83, 0.1);
208 | }
209 | :is(.success, .check, .done) > :is(.admonition-title, summary)::before {
210 | background-color: #00c853;
211 | mask-image: var(--md-admonition-icon--success);
212 | -webkit-mask-image: var(--md-admonition-icon--success);
213 | mask-repeat: no-repeat;
214 | -webkit-mask-repeat: no-repeat;
215 | mask-size: contain;
216 | -webkit-mask-repeat: no-repeat;
217 | }
218 |
219 | :is(.admonition):is(.question, .help, .faq) {
220 | border-color: #64dd17;
221 | }
222 |
223 | :is(.question, .help, .faq) > :is(.admonition-title, summary) {
224 | background-color: rgba(100, 221, 23, 0.1);
225 | }
226 | :is(.question, .help, .faq) > :is(.admonition-title, summary)::before {
227 | background-color: #64dd17;
228 | mask-image: var(--md-admonition-icon--question);
229 | -webkit-mask-image: var(--md-admonition-icon--question);
230 | mask-repeat: no-repeat;
231 | -webkit-mask-repeat: no-repeat;
232 | mask-size: contain;
233 | -webkit-mask-repeat: no-repeat;
234 | }
235 |
236 | :is(.admonition):is(.warning, .caution, .attention) {
237 | border-color: #ff9100;
238 | }
239 |
240 | :is(.warning, .caution, .attention) > :is(.admonition-title, summary) {
241 | background-color: rgba(255, 145, 0, 0.1);
242 | }
243 | :is(.warning, .caution, .attention) > :is(.admonition-title, summary)::before {
244 | background-color: #ff9100;
245 | mask-image: var(--md-admonition-icon--warning);
246 | -webkit-mask-image: var(--md-admonition-icon--warning);
247 | mask-repeat: no-repeat;
248 | -webkit-mask-repeat: no-repeat;
249 | mask-size: contain;
250 | -webkit-mask-repeat: no-repeat;
251 | }
252 |
253 | :is(.admonition):is(.failure, .fail, .missing) {
254 | border-color: #ff5252;
255 | }
256 |
257 | :is(.failure, .fail, .missing) > :is(.admonition-title, summary) {
258 | background-color: rgba(255, 82, 82, 0.1);
259 | }
260 | :is(.failure, .fail, .missing) > :is(.admonition-title, summary)::before {
261 | background-color: #ff5252;
262 | mask-image: var(--md-admonition-icon--failure);
263 | -webkit-mask-image: var(--md-admonition-icon--failure);
264 | mask-repeat: no-repeat;
265 | -webkit-mask-repeat: no-repeat;
266 | mask-size: contain;
267 | -webkit-mask-repeat: no-repeat;
268 | }
269 |
270 | :is(.admonition):is(.danger, .error) {
271 | border-color: #ff1744;
272 | }
273 |
274 | :is(.danger, .error) > :is(.admonition-title, summary) {
275 | background-color: rgba(255, 23, 68, 0.1);
276 | }
277 | :is(.danger, .error) > :is(.admonition-title, summary)::before {
278 | background-color: #ff1744;
279 | mask-image: var(--md-admonition-icon--danger);
280 | -webkit-mask-image: var(--md-admonition-icon--danger);
281 | mask-repeat: no-repeat;
282 | -webkit-mask-repeat: no-repeat;
283 | mask-size: contain;
284 | -webkit-mask-repeat: no-repeat;
285 | }
286 |
287 | :is(.admonition):is(.bug) {
288 | border-color: #f50057;
289 | }
290 |
291 | :is(.bug) > :is(.admonition-title, summary) {
292 | background-color: rgba(245, 0, 87, 0.1);
293 | }
294 | :is(.bug) > :is(.admonition-title, summary)::before {
295 | background-color: #f50057;
296 | mask-image: var(--md-admonition-icon--bug);
297 | -webkit-mask-image: var(--md-admonition-icon--bug);
298 | mask-repeat: no-repeat;
299 | -webkit-mask-repeat: no-repeat;
300 | mask-size: contain;
301 | -webkit-mask-repeat: no-repeat;
302 | }
303 |
304 | :is(.admonition):is(.example) {
305 | border-color: #7c4dff;
306 | }
307 |
308 | :is(.example) > :is(.admonition-title, summary) {
309 | background-color: rgba(124, 77, 255, 0.1);
310 | }
311 | :is(.example) > :is(.admonition-title, summary)::before {
312 | background-color: #7c4dff;
313 | mask-image: var(--md-admonition-icon--example);
314 | -webkit-mask-image: var(--md-admonition-icon--example);
315 | mask-repeat: no-repeat;
316 | -webkit-mask-repeat: no-repeat;
317 | mask-size: contain;
318 | -webkit-mask-repeat: no-repeat;
319 | }
320 |
321 | :is(.admonition):is(.quote, .cite) {
322 | border-color: #9e9e9e;
323 | }
324 |
325 | :is(.quote, .cite) > :is(.admonition-title, summary) {
326 | background-color: rgba(158, 158, 158, 0.1);
327 | }
328 | :is(.quote, .cite) > :is(.admonition-title, summary)::before {
329 | background-color: #9e9e9e;
330 | mask-image: var(--md-admonition-icon--quote);
331 | -webkit-mask-image: var(--md-admonition-icon--quote);
332 | mask-repeat: no-repeat;
333 | -webkit-mask-repeat: no-repeat;
334 | mask-size: contain;
335 | -webkit-mask-repeat: no-repeat;
336 | }
337 |
338 | .navy :is(.admonition) {
339 | background-color: var(--sidebar-bg);
340 | }
341 |
342 | .ayu :is(.admonition), .coal :is(.admonition) {
343 | background-color: var(--theme-hover);
344 | }
345 |
346 | .rust :is(.admonition) {
347 | background-color: var(--sidebar-bg);
348 | color: var(--sidebar-fg);
349 | }
350 | .rust .admonition-anchor-link:link, .rust .admonition-anchor-link:visited {
351 | color: var(--sidebar-fg);
352 | }
--------------------------------------------------------------------------------
/pt/theme/css/style.css:
--------------------------------------------------------------------------------
1 | h4 {
2 | font-size: 17px;
3 | }
4 | h5 {
5 | font-size: 16px;
6 | }
7 |
8 | #sidebar .sidebar-scrollbox {
9 | font-size: 18px;
10 | }
11 | #sidebar .sidebar-scrollbox .chapter-item a {
12 | margin-bottom: 10px;
13 | }
14 | #sidebar .sidebar-scrollbox .chapter-item.affix a {
15 | margin-top: 20px;
16 | margin-bottom: 20px;
17 | }
18 | #sidebar .sidebar-scrollbox .chapter-item a strong {
19 | display: none;
20 | margin-bottom: 10px;
21 | }
22 |
23 | #sidebar .sidebar-scrollbox .part-title {
24 | margin-top: 20px;
25 | margin-bottom: 20px;
26 | }
27 |
28 | details {
29 | /* margin: 1rem auto; */
30 | /* width: 35em; */
31 | /* max-width: calc(100% - 2rem); */
32 | padding: 0 1rem;
33 | position: relative;
34 | border: 1px solid #ffffff;
35 | border-radius: 6px;
36 | background-color: #ffffff;
37 | color: #263238;
38 | transition: background-color 0.15s;
39 | }
40 | details > :last-child {
41 | margin-bottom: 1rem;
42 | }
43 | details::before {
44 | width: 100%;
45 | height: 100%;
46 | content: "";
47 | position: absolute;
48 | top: 0;
49 | left: 0;
50 | border-radius: inherit;
51 | opacity: 0.15;
52 | box-shadow: 0 0.25em 0.5em #263238;
53 | pointer-events: none;
54 | transition: opacity 0.2s;
55 | z-index: -1;
56 | }
57 | details[open] {
58 | background-color: #FFF;
59 | }
60 | details[open]::before {
61 | opacity: 0.6;
62 | }
63 |
64 | summary.summary {
65 | padding: 1rem 2em 1rem 0;
66 | display: block;
67 | position: relative;
68 | font-size: 1.33em;
69 | font-weight: bold;
70 | cursor: pointer;
71 | background-color: #FFF;
72 | margin-inline: 0;
73 | padding-block: 40;
74 | padding-inline: 0;
75 | }
76 | summary.summary::before, summary.summary::after {
77 | width: 0.75em;
78 | height: 2px;
79 | position: absolute;
80 | top: 50%;
81 | right: 0;
82 | content: "";
83 | background-color: currentColor;
84 | text-align: right;
85 | transform: translateY(-50%);
86 | transition: transform 0.2s ease-in-out;
87 | inset-inline-start: 33.3em;
88 | mask-image: none;
89 | -webkit-mask-image: none;
90 | }
91 | summary.summary::after {
92 | transform: translateY(-50%) rotate(90deg);
93 | }
94 | [open] summary.summary::after {
95 | transform: translateY(-50%) rotate(180deg);
96 | }
97 | summary.summary::-webkit-details-marker {
98 | display: none;
99 | }
100 |
101 | code {
102 | padding: 0.2em;
103 | border-radius: 3px;
104 | background-color: #E0E0E0;
105 | }
106 | pre > code {
107 | display: block;
108 | padding: 1em;
109 | margin: 0;
110 | }
--------------------------------------------------------------------------------
/pt/theme/index.hbs:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | {{ book_title }}
7 | {{#if is_print }}
8 |
9 | {{/if}}
10 | {{#if base_url}}
11 |
12 | {{/if}}
13 |
14 |
15 |
16 | {{> head}}
17 |
18 |
19 |
20 |
21 |
22 |
23 | {{#if favicon_svg}}
24 |
25 | {{/if}}
26 | {{#if favicon_png}}
27 |
28 | {{/if}}
29 |
30 |
31 |
32 | {{#if print_enable}}
33 |
34 | {{/if}}
35 |
36 |
37 |
38 | {{#if copy_fonts}}
39 |
40 | {{/if}}
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 | {{#each additional_css}}
49 |
50 | {{/each}}
51 |
52 | {{#if mathjax_support}}
53 |
54 |
55 | {{/if}}
56 |
57 |
58 |
59 |
63 |
64 |
65 |
79 |
80 |
81 |
91 |
92 |
93 |
103 |
104 |
110 |
111 |