├── .github
└── workflows
│ └── ci.yaml
├── .gitignore
├── LICENSE
├── README.md
├── docs
├── argocd-webhook.md
├── ha-kubernetes-cluster-with-rke2.md
├── howto-use-kubernetes-secrets.md
├── index.md
├── install-argocd.md
├── install-gitlab-ce-k8s.md
├── install-jenkins.md
├── install-nginx.md
├── install-sonarqube.md
├── jenkins-in-kubernetes.md
├── jenkins-ssh-agent.md
├── jenkins-ssl.md
├── k3sup-ha.md
├── kubernetes-certifcates-traefik.md
├── nexus3-with-tls.md
├── rancher-manager-with-lets-encrypt.md
├── truenas-core-tls.md
└── versions.json
├── mkdocs.yml
└── requirements.txt
/.github/workflows/ci.yaml:
--------------------------------------------------------------------------------
1 | name: ci
2 | on:
3 | push:
4 | branches:
5 | - master
6 | - main
7 |
8 | permissions:
9 | contents: write
10 |
11 | jobs:
12 | deploy:
13 | runs-on: ubuntu-latest
14 | steps:
15 | - uses: actions/checkout@v3
16 | - uses: actions/setup-python@v4
17 | with:
18 | python-version: 3.11.2
19 | - uses: actions/cache@v2
20 | with:
21 | key: ${{ github.ref }}
22 | path: .cache
23 | - run: pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mike
24 | - run: mkdocs gh-deploy --force
25 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | wheels/
23 | pip-wheel-metadata/
24 | share/python-wheels/
25 | *.egg-info/
26 | .installed.cfg
27 | *.egg
28 | MANIFEST
29 |
30 | # PyInstaller
31 | # Usually these files are written by a python script from a template
32 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
33 | *.manifest
34 | *.spec
35 |
36 | # Installer logs
37 | pip-log.txt
38 | pip-delete-this-directory.txt
39 |
40 | # Unit test / coverage reports
41 | htmlcov/
42 | .tox/
43 | .nox/
44 | .coverage
45 | .coverage.*
46 | .cache
47 | nosetests.xml
48 | coverage.xml
49 | *.cover
50 | *.py,cover
51 | .hypothesis/
52 | .pytest_cache/
53 |
54 | # Translations
55 | *.mo
56 | *.pot
57 |
58 | # Django stuff:
59 | *.log
60 | local_settings.py
61 | db.sqlite3
62 | db.sqlite3-journal
63 |
64 | # Flask stuff:
65 | instance/
66 | .webassets-cache
67 |
68 | # Scrapy stuff:
69 | .scrapy
70 |
71 | # Sphinx documentation
72 | docs/_build/
73 |
74 | # PyBuilder
75 | target/
76 |
77 | # Jupyter Notebook
78 | .ipynb_checkpoints
79 |
80 | # IPython
81 | profile_default/
82 | ipython_config.py
83 |
84 | # pyenv
85 | .python-version
86 |
87 | # pipenv
88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies
90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not
91 | # install all needed dependencies.
92 | #Pipfile.lock
93 |
94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95 | __pypackages__/
96 |
97 | # Celery stuff
98 | celerybeat-schedule
99 | celerybeat.pid
100 |
101 | # SageMath parsed files
102 | *.sage.py
103 |
104 | # Environments
105 | .env
106 | .venv
107 | env/
108 | venv/
109 | ENV/
110 | env.bak/
111 | venv.bak/
112 |
113 | # Spyder project settings
114 | .spyderproject
115 | .spyproject
116 |
117 | # Rope project settings
118 | .ropeproject
119 |
120 | # mkdocs documentation
121 | /site
122 |
123 | # mypy
124 | .mypy_cache/
125 | .dmypy.json
126 | dmypy.json
127 |
128 | # Pyre type checker
129 | .pyre/
130 |
--------------------------------------------------------------------------------
/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 | # tutorial-documentation
2 | Documentation for Tutorials
3 |
4 |
5 |
6 |
7 |
--------------------------------------------------------------------------------
/docs/argocd-webhook.md:
--------------------------------------------------------------------------------
1 | # Argo CD Git Webhook Configuration
2 | By default, Argo CD polls the Git repositories every 3 minutes to detect the changes made on the repo. If you want to remove the delay, you can configure a webhook event to send a notification to the API server.
3 | ## Create a Webhook in GitHub
4 | Login to your Github repository and navigate to settings > webhooks and click ```add webhook```
5 |
6 | The payload URL is your ArgoCD Server + /api/webhook
7 |
8 | For example.
9 |
10 | ```https://argocd.example.com/api/webhook```
11 |
12 | If you wish to use a shared secret, input a value in the secret, remember this as we will create a secret in the argocd installation below.
13 |
14 | Content type needs to be set to ```application/json```
15 |
16 | Note: If ArgoCD is publicly accessible, then configuring a webhook secret is highly recommended.
17 |
18 | ## Create a Webhook Secret in ArgoCD
19 | Edit the Argo CD kubernetes secret
20 | ``` shell title="Run from shell prompt" linenums="1"
21 | kubectl edit secret argocd-secret -n argocd
22 | ```
23 | TIP: for ease of entering secrets, kubernetes supports inputting secrets in the stringData field, which saves you the trouble of base64 encoding the values and copying it to the data field. Simply copy the shared webhook secret created in step 1, to the stringData field
24 | ``` yaml title="Edit secrets and apply" linenums="1"
25 | apiVersion: v1
26 | kind: Secret
27 | metadata:
28 | name: argocd-secret
29 | namespace: argocd
30 | type: Opaque
31 | data:
32 | ...
33 |
34 | stringData:
35 | webhook.github.secret: SecretCreatedInGithub
36 | ```
37 |
38 |
--------------------------------------------------------------------------------
/docs/ha-kubernetes-cluster-with-rke2.md:
--------------------------------------------------------------------------------
1 | # HA Kubernetes with RKE2 & Kube-VIP
2 | kube-vip provides Kubernetes clusters with a virtual IP and load balancer for both the control plane (for building a highly-available cluster) and Kubernetes Services of type LoadBalancer without relying on any external hardware or software.
3 |
4 | ## Prerequsites
5 |
6 | !!! info "System Requirements"
7 | Three (3) linux virtual machines with statically configured IPs. It is recommended that the virtual machines have an **A Record** pointing to the IP address of the host.
8 |
9 | A floating IP Address for the Virtual IP to access the cluster. It is recommended that to have an **A Record** pointing to the floating IP Address.
10 |
11 |
12 | ## Configure the first master node
13 | ``` shell title="Become root"
14 | sudo -i
15 | ```
16 | ### Update Package Repository and Upgrade Packages
17 | ``` shell title="Run from shell prompt"
18 | apt-get update && sudo apt upgrade -y
19 | ```
20 | ```sh title="Run from shell prompt"
21 | apt-get -y install gnupg2 ca-certificates \
22 | curl apt-transport-https iptables
23 | ```
24 |
25 | ### Install kubectl (optional if already installed)
26 | Additional Information - https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/
27 | ``` shell title="Run from shell prompt" linenums="1"
28 | apt update
29 | apt install ca-certificates curl apt-transport-https -y
30 | curl -fsSLo /usr/share/keyrings/kubernetes-archive-keyring.gpg https://packages.cloud.google.com/apt/doc/apt-key.gpg
31 | echo "deb [signed-by=/usr/share/keyrings/kubernetes-archive-keyring.gpg] https://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee /etc/apt/sources.list.d/kubernetes.list
32 | apt update
33 | apt install kubectl -y
34 | ```
35 |
36 | ### Prepare configuration file for k8s-master01
37 |
38 | ``` shell title="Run from shell prompt"
39 | mkdir -p /etc/rancher/rke2
40 | ```
41 | ``` shell title="Run from shell prompt"
42 | vi /etc/rancher/rke2/config.yaml
43 | ```
44 | ``` shell title="Paste the below contents" linenums="1"
45 | tls-san:
46 | - k8s-master01
47 | - k8s-master01.dev.dman.cloud
48 | - k8s-cluster.dev.dman.cloud
49 | - 192.168.1.20
50 | disable: rke2-ingress-nginx
51 | cni:
52 | - calico
53 | ```
54 |
55 |
56 | ### Install RKE2 on k8s-master01 node
57 | ``` shell title="Export variables we will use to configure kube-vip" linenums="1"
58 | export VIP=192.168.1.20
59 | export TAG=v0.5.11
60 | export INTERFACE=ens192
61 | export CONTAINER_RUNTIME_ENDPOINT=unix:///run/k3s/containerd/containerd.sock
62 | export CONTAINERD_ADDRESS=/run/k3s/containerd/containerd.sock
63 | export PATH=/var/lib/rancher/rke2/bin:$PATH
64 | export KUBECONFIG=/etc/rancher/rke2/rke2.yaml
65 | ```
66 | ``` shell title="Let's create an alias to save us some time"
67 | alias k=kubectl
68 | ```
69 |
70 | ``` shell title="Install RKE2 on master node 1"
71 | curl -sfL https://get.rke2.io | sh -
72 | ```
73 | ```sh
74 | systemctl enable rke2-server
75 | ```
76 | ``` shell
77 | systemctl start rke2-server
78 | ```
79 |
80 | ### Copy Token and Save
81 | ``` shell title="Run from shell prompt"
82 | cat /var/lib/rancher/rke2/server/token
83 | ```
84 | ### Install kube-vip on k8s-master01 node
85 | ``` shell title="Configure roles for kube-vip"
86 | curl -s https://kube-vip.io/manifests/rbac.yaml > /var/lib/rancher/rke2/server/manifests/kube-vip-rbac.yaml
87 | ```
88 | ``` shell title="Pull latest kube-vip"
89 | crictl pull docker.io/plndr/kube-vip:$TAG
90 | ```
91 | ``` shell title="Create an alias for kube-vip to save time"
92 | alias kube-vip="ctr --namespace k8s.io run --rm --net-host docker.io/plndr/kube-vip:$TAG vip /kube-vip"
93 | ```
94 | ``` shell title="Create a daemonset manifest to run kube-vip"
95 | kube-vip manifest daemonset \
96 | --arp \
97 | --interface $INTERFACE \
98 | --address $VIP \
99 | --controlplane \
100 | --leaderElection \
101 | --taint \
102 | --services \
103 | --inCluster | tee /var/lib/rancher/rke2/server/manifests/kube-vip.yaml
104 | ```
105 |
106 | ### Check to see if kube-vip pod is running
107 | ``` shell title="Find the running kube-vip pods"
108 | kubectl get pod -n kube-system | grep kube-vip
109 | ```
110 | ``` shell title="Find the node elected as leader"
111 | kubectl logs --tail 100 -n kube-system | grep -i leader
112 | ```
113 | ### Verify the floating IP Status
114 | ``` shell title="Run from shell prompt"
115 | ping 192.168.1.20
116 | ```
117 |
118 | ## Prepare configuration file for k8s-master02 node
119 | ### Login into the second master node
120 | ``` shell title="Become root"
121 | sudo -i
122 | ```
123 | ``` shell title="Run from shell prompt"
124 | mkdir -p /etc/rancher/rke2
125 | ```
126 | ``` shell title="Run from shell prompt"
127 | vi /etc/rancher/rke2/config.yaml
128 | ```
129 | ``` shell title="Paste the below values remember to use the token copied above" linenums="1"
130 | token:
131 | server: https://k8s-cluster.dev.dman.cloud:9345
132 | tls-san:
133 | - k8s-master02
134 | - k8s-master02.dev.dman.cloud
135 | - k8s-cluster.dev.dman.cloud
136 | - 192.168.1.20
137 | disable: rke2-ingress-nginx
138 | cni:
139 | - calico
140 | ```
141 |
142 | ``` shell title="Download RKE2"
143 | curl -sfL https://get.rke2.io | sh -
144 | ```
145 | ``` shell title="Enable RKE2"
146 | systemctl enable rke2-server
147 | ```
148 | ``` shell title="Start RKE2"
149 | systemctl start rke2-server
150 | ```
151 |
152 | ## Prepare configuration file for k8s-master03 node
153 | ### Login into the third master node
154 | ``` shell title="Become root"
155 | sudo -i
156 | ```
157 |
158 | ``` shell title="Run from shell prompt"
159 | mkdir -p /etc/rancher/rke2
160 | ```
161 | ``` shell title="Run from shell prompt"
162 | vi /etc/rancher/rke2/config.yaml
163 | ```
164 | ``` shell title="Paste the below values remember to use the token copied above" linenums="1"
165 | token:
166 | server: https://k8s-cluster.dev.dman.cloud:9345
167 | tls-san:
168 | - k8s-master03
169 | - k8s-master03.dev.dman.cloud
170 | - k8s-cluster.dev.dman.cloud
171 | - 192.168.1.20
172 | disable: rke2-ingress-nginx
173 | cni:
174 | - calico
175 | ```
176 |
177 | ``` shell title="Download RKE2"
178 | curl -sfL https://get.rke2.io | sh -
179 | ```
180 | ``` shell title="Enable RKE2"
181 | systemctl enable rke2-server
182 | ```
183 | ``` shell title="Start RKE2"
184 | systemctl start rke2-server
185 | ```
186 |
187 | ## Check that kube-vip is running on all nodes
188 | Go back to master node 1 where we installed kubectl
189 | ``` shell title="Run from shell prompt"
190 | kubectl get pod -n kube-system | grep kube-vip
191 | ```
192 | ## Finally copy and edit the kubeconfig to talk to VIP
193 | ``` shell title="Run from shell prompt"
194 | cp /etc/rancher/rke2/rke2.yaml .
195 | ```
196 | ``` shell title="Run from shell prompt"
197 | vi rke2.yaml
198 | ```
199 | Edit Server Address: https://127.0.0.1:6443 and replace with VIP
200 | ``` shell title="Run from shell prompt"
201 | kubectl --kubeconfig ./rke2.yaml get nodes
202 | ```
203 |
204 | You should now be able to test kube-vip is load balancing by shutting down one of the nodes and watching.
--------------------------------------------------------------------------------
/docs/howto-use-kubernetes-secrets.md:
--------------------------------------------------------------------------------
1 | # How to use Kubernetes Secrets
2 | ## Create Kubernetes secrets using kubectl and --from-literal
3 | The easiest ways to create the Kubernetes secret is by using the kubectl command and --from-literal flag. For example to understand Kubernetes secret creation we need three things.
4 |
5 | - secret-name - test-secret
6 | - username - test-user
7 | - password - testP@ssword
8 |
9 | ``` shell title="Run from shell prompt" linenums="1"
10 | kubectl create secret generic test-secret --from-literal=username=test-user --from-literal=password=testP@ssword
11 | ```
12 | ### Verify the secret using the following command
13 | ``` shell title="Run from shell prompt" linenums="1"
14 | kubectl get secret test-secret
15 | ```
16 | ### Describe The Secret
17 | ``` shell title="Run from shell prompt" linenums="1"
18 | kubectl describe secret test-secret
19 | ```
20 | ### Base64 Encoded Kubernetes Secrets
21 | ``` shell title="Run from shell prompt" linenums="1"
22 | echo -n ‘test-user’ | base64
23 | ```
24 | ## Using Kubernetes Secrets In A Deployment (mysql)
25 | ### Create a secret
26 | ``` yaml title="Create Secret" linenums="1"
27 | apiVersion: v1
28 | kind: Secret
29 | metadata:
30 | name: mysql-test-secret
31 | type: kubernetes.io/basic-auth
32 | stringData:
33 | password: test1234
34 | ```
35 | ### Create a deployment
36 | ``` yaml title="Create Deployment" linenums="1"
37 | apiVersion: apps/v1
38 | kind: Deployment
39 | metadata:
40 | name: mysql
41 | spec:
42 | selector:
43 | matchLabels:
44 | app: mysql
45 | strategy:
46 | type: Recreate
47 | template:
48 | metadata:
49 | labels:
50 | app: mysql
51 | spec:
52 | containers:
53 | - image: mysql
54 | name: mysql
55 | env:
56 | - name: MYSQL_ROOT_PASSWORD
57 | valueFrom:
58 | secretKeyRef:
59 | name: mysql-test-secret
60 | key: password
61 | ports:
62 | - containerPort: 3306
63 | name: mysql
64 | ```
65 |
--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
1 | # About
2 | Hi! My name is Dinesh I create content on YouTube.
3 |
4 | Here you will find all the documentation for my YouTube videos on my channel https://www.youtube.com/@dineshmistry. This documentation is meant to compliment my videos and not replace them.
5 |
6 | My mission is to help you learn and master the art of DevOps, one video at a time. DevOps is a rapidly evolving field that combines software development and IT operations to accelerate the delivery of high-quality software products. It emphasizes collaboration, automation, and continuous improvement to deliver value to customers faster and more reliably. My channel is dedicated to providing you with the latest DevOps knowledge, best practices, and insights to help you achieve your goals.
7 |
8 | I believe in making DevOps accessible and easy to understand, so we explain complex concepts in simple terms and provide step-by-step instructions to guide you through practical examples. My goal is to empower you with the knowledge and skills you need to build better software and advance your career.
9 |
10 | Subscribe to the channel today to stay informed and engaged with the DevOps community, and join us on this exciting journey of learning and growth!
--------------------------------------------------------------------------------
/docs/install-argocd.md:
--------------------------------------------------------------------------------
1 | # ArgoCD Installation
2 | Argo CD is a declarative continuous delivery tool for Kubernetes applications. It uses the GitOps style to create and manage Kubernetes clusters. When any changes are made to the application configuration in Git, Argo CD will compare it with the configurations of the running application and notify users to bring the desired and live state into sync.
3 |
4 | ## Prerequsites
5 | - Virtual Machine running Ubuntu 22.04 or newer
6 | ### Update Package Repository and Upgrade Packages
7 | ``` console title="Run from shell prompt" linenums="1"
8 | sudo apt update
9 | sudo apt upgrade
10 | ```
11 | ## Create Kubernetes Cluster
12 | ``` bash title="Run from shell prompt" linenums="1"
13 | sudo bash
14 | curl -sfL https://get.k3s.io | INSTALL_K3S_EXEC="server" sh -s - --disable traefik
15 | exit
16 | mkdir .kube
17 | sudo cp /etc/rancher/k3s/k3s.yaml ./config
18 | sudo chown dmistry:dmistry config
19 | chmod 400 config
20 | export KUBECONFIG=~/.kube/config
21 | ```
22 |
23 | ### Install ArgoCD
24 | ``` shell title="Run from shell prompt" linenums="1"
25 | kubectl create namespace argocd
26 | kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml
27 | ```
28 | ### Change Service to NodePort
29 | Edit the service can change the service type from `ClusterIP` to `NodePort`
30 | ``` shell title="Run from shell prompt" linenums="1"
31 | kubectl patch svc argocd-server -n argocd -p '{"spec": {"type": "NodePort"}}'
32 | ```
33 | ### Fetch Password
34 | ``` shell title="Run from shell prompt" linenums="1"
35 | kubectl -n argocd get secret argocd-initial-admin-secret -o jsonpath="{.data.password}" | base64 -d
36 | ```
37 |
38 | # Optional (Enable TLS w/Ingress)
39 | If you want to enable access from the internet or private network you can follow the instructions below to install and configure an ingress-controller with lets-encrypt.
40 | ``` shell title="Install Cert-Manager" linenums="1"
41 | helm repo add jetstack https://charts.jetstack.io
42 | helm repo update
43 | helm install \
44 | cert-manager jetstack/cert-manager \
45 | --namespace cert-manager \
46 | --create-namespace \
47 | --version v1.11.0 \
48 | --set installCRDs=true
49 | ```
50 | Create Cluster Issuser for Lets Encrypt `vi letsencrypt-product.yaml` and paste the below contents adjust your email address
51 | ``` shell title="Create a cluster issuer manifest" linenums="1"
52 | apiVersion: cert-manager.io/v1
53 | kind: ClusterIssuer
54 | metadata:
55 | name: letsencrypt-prod
56 | spec:
57 | acme:
58 | server: https://acme-v02.api.letsencrypt.org/directory
59 | email: dinesh@dman.cloud
60 | privateKeySecretRef:
61 | name: letsencrypt-prod
62 | solvers:
63 | - http01:
64 | ingress:
65 | class: nginx
66 | ```
67 | ``` shell title="Apply manifest" linenums="1"
68 | kubectl apply -f letsencrypt-product.yaml
69 | ```
70 | Deploy nginx-ingress controller
71 | ``` shell title="Apply manifest" linenums="1"
72 | kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.7.0/deploy/static/provider/cloud/deploy.yaml
73 | ```
74 | Create ingress for ArgoCD `vi ingress.yaml` and paste the below contents adjust the domain name
75 | ``` shell title="Apply manifest" linenums="1"
76 | apiVersion: networking.k8s.io/v1
77 | kind: Ingress
78 | metadata:
79 | name: argocd-server-ingress
80 | namespace: argocd
81 | annotations:
82 | cert-manager.io/cluster-issuer: letsencrypt-prod
83 | kubernetes.io/ingress.class: nginx
84 | kubernetes.io/tls-acme: "true"
85 | nginx.ingress.kubernetes.io/ssl-passthrough: "true"
86 | # If you encounter a redirect loop or are getting a 307 response code
87 | # then you need to force the nginx ingress to connect to the backend using HTTPS.
88 | #
89 | nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
90 | spec:
91 | rules:
92 | - host: argocd.dev.dman.cloud
93 | http:
94 | paths:
95 | - path: /
96 | pathType: Prefix
97 | backend:
98 | service:
99 | name: argocd-server
100 | port:
101 | name: https
102 | tls:
103 | - hosts:
104 | - argocd.dev.dman.cloud
105 | secretName: argocd-secret # do not change, this is provided by Argo CD
106 | ```
107 | ``` shell title="Apply manifest" linenums="1"
108 | kubectl apply -f ingress.yaml
109 | ```
110 | # Install ArgoCD command line tool
111 | Download With Curl
112 | ``` shell title="Run from shell" linenums="1"
113 | curl -sSL -o argocd-linux-amd64 https://github.com/argoproj/argo-cd/releases/latest/download/argocd-linux-amd64
114 | sudo install -m 555 argocd-linux-amd64 /usr/local/bin/argocd
115 | rm argocd-linux-amd64
116 | ```
117 |
118 | ## Login to ArgoCD from the CLI and change the password
119 | ``` shell title="Remember to swap your domain name below" linenums="1"
120 | argocd login argocd.dev.dman.cloud
121 | ```
122 | ``` shell title="Update password" linenums="1"
123 | argocd account update-password
124 | ```
125 | # Deploy Demo Application
126 | You can use the below repository to deploy a demo nginx application
127 | ``` shell title="This repository has a sample application" linenums="1"
128 | https://github.com/dmancloud/argocd-tutorial
129 | ```
130 | ### Scale Replicaset
131 | ``` shell title="Run from shell prompt" linenums="1"
132 | kubectl scale --replicas=3 deployment nginx -n default
133 | ```
134 |
135 | ## Clean Up
136 | ``` shell title="Run from shell prompt" linenums="1"
137 | kubectl delete -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml
138 | kubectl delete namespace argocd
139 | ```
140 |
--------------------------------------------------------------------------------
/docs/install-gitlab-ce-k8s.md:
--------------------------------------------------------------------------------
1 | # Install Gitlab CE on Kubernetes
2 |
3 | Are you looking to streamline your CI/CD pipeline and improve collaboration across your development teams? Deploying GitLab on Kubernetes can help you achieve these goals and more. In this step-by-step tutorial, I will walk you through everything you need to know to get started with GitLab on Kubernetes.
4 |
5 | ## Prerequisites
6 | To complete this tutorial, you must have the following:
7 |
8 | - Virtual Machine running Ubuntu Linux
9 | - Domain, and ability to modify DNS records.
10 |
11 | ### DNS
12 | You will need to make sure that the below DNS entries are made prior to attempting to install Gitblab CE. These DNS entries will be used to create TLS Certificates for your installation.
13 |
14 | - gitlab.dev.dman.cloud
15 | - minio.dev.dman.cloud
16 | - registry.dev.dman.cloud
17 | - kas.dev.dman.cloud
18 |
19 | ## Create Kubernetes Cluster
20 | ``` shell title="Run from shell prompt" linenums="1"
21 | sudo bash
22 | curl -sfL https://get.k3s.io | INSTALL_K3S_EXEC="server" sh -s - --disable traefik
23 | exit
24 | mkdir .kube
25 | sudo cp /etc/rancher/k3s/k3s.yaml ./config
26 | sudo chown dmistry:dmistry config
27 | chmod 400 config
28 | export KUBECONFIG=~/.kube/config
29 | ```
30 |
31 | ## Install MetalLB (LoadBalancer) - Optional Step
32 | ``` shell title="Run from shell prompt" linenums="1"
33 | kubectl apply -f https://raw.githubusercontent.com/metallb/metallb/v0.13.9/config/manifests/metallb-native.yaml
34 | ```
35 | Next we need to configure MetalLB
36 | ``` shell title="Run from shell prompt" linenums="1"
37 | vim IPAddressPool.yaml
38 | ```
39 |
40 | ``` yaml title="Copy and Paste the below remembering to change you network range below" linenums="1"
41 | apiVersion: metallb.io/v1beta1
42 | kind: IPAddressPool
43 | metadata:
44 | name: first-pool
45 | namespace: metallb-system
46 | spec:
47 | addresses:
48 | - 192.168.1.18/32
49 |
50 | ```
51 | ``` shell title="Run from shell prompt" linenums="1"
52 | vim L2Advertisement.yaml
53 | ```
54 | ``` yaml title="Copy and Paste the below" linenums="1"
55 | apiVersion: metallb.io/v1beta1
56 | kind: L2Advertisement
57 | metadata:
58 | name: gitlab-ce
59 | namespace: metallb-system
60 | ```
61 | ``` shell title="Apply the configuration" linenums="1"
62 | kubectl apply -f IPAddressPool.yaml
63 | kubectl apply -f L2Advertisement.yaml
64 | ```
65 |
66 | ## Install Helm
67 | ``` shell title="Run from shell prompt" linenums="1"
68 | curl https://baltocdn.com/helm/signing.asc | gpg --dearmor | sudo tee /usr/share/keyrings/helm.gpg > /dev/null
69 | sudo apt-get install apt-transport-https --yes
70 | echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/helm.gpg] https://baltocdn.com/helm/stable/debian/ all main" | sudo tee /etc/apt/sources.list.d/helm-stable-debian.list
71 | sudo apt-get update
72 | sudo apt-get install helm
73 | ```
74 | ## Install Gitlab CE
75 | ### Add the GitLab Helm repository
76 | ``` shell title="Run from shell prompt" linenums="1"
77 | helm repo add gitlab https://charts.gitlab.io/
78 | helm repo update
79 | ```
80 | ``` shell title="Install the gitlab chart" linenums="1"
81 | helm install gitlab gitlab/gitlab \
82 | --timeout 600s \
83 | --set global.hosts.domain=dev.dman.cloud \
84 | --set certmanager-issuer.email=dinesh@dman.cloud \
85 | --set global.edition=ce \
86 | --set postgresql.image.tag=13.6.0
87 | ```
88 | ###Fetch Initial Password
89 | ``` shell title="Run from shell prompt" linenums="1"
90 | kubectl get secret gitlab-gitlab-initial-root-password -ojsonpath='{.data.password}' | base64 --decode ; echo
91 | ```
92 |
93 |
--------------------------------------------------------------------------------
/docs/install-jenkins.md:
--------------------------------------------------------------------------------
1 | # Jenkins Installation
2 | !!! info "Prerequsites"
3 | Virtual Machine running Ubuntu 22.04 or newer
4 |
5 | ### Update Package Repository and Upgrade Packages
6 |
7 | ``` shell title="Become root"
8 | sudo -i
9 | ```
10 |
11 | ``` shell title="Run from shell prompt" linenums="1"
12 | sudo apt update
13 | sudo apt upgrade
14 | ```
15 |
16 | ## Adoptium Java 17
17 |
18 | ### Add Adoptium repository
19 | ``` shell title="Add adoptium repository" linenums="1"
20 | wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | tee /etc/apt/keyrings/adoptium.asc
21 | echo "deb [signed-by=/etc/apt/keyrings/adoptium.asc] https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | tee /etc/apt/sources.list.d/adoptium.list
22 | ```
23 | ### Install Java 17
24 | ``` shell title="Update repository and install Java" linenums="1"
25 | apt update
26 | apt install temurin-17-jdk
27 | /usr/bin/java --version
28 | exit
29 | ```
30 |
31 |
32 | ## Install Jenkins
33 | First, add the repository key to the system:
34 | ``` shell title="Run from shell prompt"
35 | curl -fsSL https://pkg.jenkins.io/debian-stable/jenkins.io-2023.key | sudo tee \
36 | /usr/share/keyrings/jenkins-keyring.asc > /dev/null
37 | echo deb [signed-by=/usr/share/keyrings/jenkins-keyring.asc] \
38 | https://pkg.jenkins.io/debian-stable binary/ | sudo tee \
39 | /etc/apt/sources.list.d/jenkins.list > /dev/null
40 | sudo apt-get update
41 | sudo apt-get install jenkins
42 | ```
43 |
44 | ### Starting Jenkins
45 | Let’s start Jenkins by using systemctl:
46 | ``` shell title="Run from shell prompt"
47 | sudo systemctl start jenkins
48 | ```
49 | Since systemctl doesn’t display status output, we’ll use the status command to verify that Jenkins started successfully:
50 | ``` shell title="Run from shell prompt"
51 | sudo systemctl status jenkins
52 | ```
53 | If everything went well, the beginning of the status output shows that the service is active and configured to start at boot:
54 | ``` shell title="Run from shell prompt"
55 | Output
56 | ● jenkins.service - LSB: Start Jenkins at boot time
57 | Loaded: loaded (/etc/init.d/jenkins; generated)
58 | Active: active (exited) since Fri 2020-06-05 21:21:46 UTC; 45s ago
59 | Docs: man:systemd-sysv-generator(8)
60 | Tasks: 0 (limit: 1137)
61 | CGroup: /system.slice/jenkins.service
62 | ```
63 | ## Access Jenkins User Interface
64 | To set up your installation, visit Jenkins on its default port, 8080, using your server domain name or IP address: http://your_server_ip_or_domain:8080
65 |
66 | ## Example Pipeline
67 | You should receive the Unlock Jenkins screen, which displays the location of the initial password:
68 | ``` groovy title="Sample Jenkinsfile" linenums="1"
69 | pipeline {
70 | agent any
71 | stages {
72 | stage('Hello World') {
73 | steps {
74 | echo 'Hello World'
75 | }
76 | }
77 | }
78 | }
79 | ```
80 |
--------------------------------------------------------------------------------
/docs/install-nginx.md:
--------------------------------------------------------------------------------
1 | # Install Nginx Reverse Proxy for Jenkins
2 | Nginx is one of the most popular web servers in the world and is responsible for hosting some of the largest and highest-traffic sites on the internet. It is a lightweight choice that can be used as either a web server or reverse proxy.
3 |
4 | In this tutorial, you will configure Nginx as a reverse proxy to direct client requests to Jenkins.
5 | !!! info "Prerequsites"
6 | Jenkins server already installed and running
7 | ### Update Package Repository and Upgrade Packages
8 |
9 | ``` shell title="Run from shell prompt" linenums="1"
10 | sudo apt update
11 | sudo apt upgrade
12 | ```
13 |
14 | ## Installing Nginx
15 | ``` shell title="Run from shell prompt"
16 | sudo apt install nginx
17 | ```
18 | ### Checking your Web Server
19 | We can check with the `systemd` init system to make sure the service is running by typing:
20 | ``` shell title="Run from shell prompt"
21 | systemctl status nginx
22 | ```
23 | We can check with the systemd init system to make sure the service is running by typing:
24 | ``` shell title="Output should look similar to the below" linenums="1"
25 | Output
26 | ● nginx.service - A high performance web server and a reverse proxy server
27 | Loaded: loaded (/lib/systemd/system/nginx.service; enabled; vendor preset: enabled)
28 | Active: active (running) since Fri 2020-04-20 16:08:19 UTC; 3 days ago
29 | Docs: man:nginx(8)
30 | Main PID: 2369 (nginx)
31 | Tasks: 2 (limit: 1153)
32 | Memory: 3.5M
33 | CGroup: /system.slice/nginx.service
34 | ├─2369 nginx: master process /usr/sbin/nginx -g daemon on; master_process on;
35 | └─2380 nginx: worker process
36 | ```
37 |
38 | Check you Web Server is running
39 | ``` shell title="Access your web server by visiting"
40 | http://your_server_ip
41 | ```
42 |
43 | In order for Nginx to serve this content, it’s necessary to create a server block with the correct directives.
44 | ``` shell title="Run from shell prompt (replace your domain)" linenums="1"
45 | sudo vi /etc/nginx/sites-available/jenkins.dev.dman.cloud
46 | ```
47 | Paste in the following configuration block, which is similar to the default, but updated for our new directory and domain name:
48 | ``` shell title="Paste the below (replace your domain)" linenums="1"
49 | upstream jenkins{
50 | server 127.0.0.1:8080;
51 | }
52 |
53 | server{
54 | listen 80;
55 | server_name jenkins.dev.dman.cloud;
56 |
57 | access_log /var/log/nginx/jenkins.access.log;
58 | error_log /var/log/nginx/jenkins.error.log;
59 |
60 | proxy_buffers 16 64k;
61 | proxy_buffer_size 128k;
62 |
63 | location / {
64 | proxy_pass http://jenkins;
65 | proxy_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504;
66 | proxy_redirect off;
67 |
68 | proxy_set_header Host $host;
69 | proxy_set_header X-Real-IP $remote_addr;
70 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
71 | proxy_set_header X-Forwarded-Proto https;
72 | }
73 |
74 | }
75 | ```
76 | Next, let’s enable the file by creating a link from it to the sites-enabled directory, which Nginx reads from during startup:
77 | ``` shell title="Run from shell prompt (replace your domain)" linenums="1"
78 | sudo ln -s /etc/nginx/sites-available/jenkins.dev.dman.cloud /etc/nginx/sites-enabled/
79 | ```
80 | Next, test to make sure that there are no syntax errors in any of your Nginx files:
81 | ``` shell title="Run from shell prompt" linenums="1"
82 | sudo nginx -t
83 | ```
84 | If there aren’t any problems, restart Nginx to enable your changes:
85 | ``` shell title="Run from shell prompt" linenums="1"
86 | sudo systemctl restart nginx
87 | ```
88 | Nginx should now be serving Jenkins from your domain name. You can test this by navigating to http://your_domain
--------------------------------------------------------------------------------
/docs/install-sonarqube.md:
--------------------------------------------------------------------------------
1 | # How to Install Sonarqube in Ubuntu Linux
2 | SonarQube is an open-source platform developed by SonarSource for continuous inspection of code quality to perform automatic reviews with static analysis of code to detect bugs and code smells on 29 programming languages.
3 | ## Prerequsites
4 | - Virtual Machine running Ubuntu 22.04 or newer
5 | ### Update Package Repository and Upgrade Packages
6 |
7 | ``` shell title="Run from shell prompt" linenums="1"
8 | sudo apt update
9 | sudo apt upgrade
10 | ```
11 | ## PostgreSQL
12 | ### Add PostgresSQL repository
13 | ``` shell title="Run from shell prompt" linenums="1"
14 | sudo sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
15 | wget -qO- https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo tee /etc/apt/trusted.gpg.d/pgdg.asc &>/dev/null
16 | ```
17 | ### Install PostgreSQL
18 | ``` shell title="Run from shell prompt" linenums="1"
19 | sudo apt update
20 | sudo apt-get -y install postgresql postgresql-contrib
21 | sudo systemctl enable postgresql
22 | ```
23 | ### Create Database for Sonarqube
24 | ``` shell title="Set password for postgres user" linenums="1"
25 | sudo passwd postgres
26 | ```
27 | ``` shell title="Change to the postgres user" linenums="1"
28 | su - postgres
29 | ```
30 | ``` shell title="Create database user postgres" linenums="1"
31 | createuser sonar
32 | ```
33 | ``` sql title="Set password and grant privileges" linenums="1"
34 | createuser sonar
35 | psql
36 | ALTER USER sonar WITH ENCRYPTED password 'sonar';
37 | CREATE DATABASE sonarqube OWNER sonar;
38 | grant all privileges on DATABASE sonarqube to sonar;
39 | \q
40 | exit
41 | ```
42 | ## Adoptium Java 17
43 | ``` shell title="Switch to root user" linenums="1"
44 | sudo bash
45 | ```
46 | ### Add Adoptium repository
47 | ``` shell title="Add adoptium repository" linenums="1"
48 | wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | tee /etc/apt/keyrings/adoptium.asc
49 | echo "deb [signed-by=/etc/apt/keyrings/adoptium.asc] https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | tee /etc/apt/sources.list.d/adoptium.list
50 | ```
51 | ### Install Java 17
52 | ``` shell title="Update repository and install Java" linenums="1"
53 | apt update
54 | apt install temurin-17-jdk
55 | update-alternatives --config java
56 | /usr/bin/java --version
57 | exit
58 | ```
59 | ## Linux Kernel Tuning
60 | ### Increase Limits
61 | ``` shell title="Run from shell prompt" linenums="1"
62 | sudo vim /etc/security/limits.conf
63 | ```
64 | Paste the below values at the bottom of the file
65 | ``` shell title="Add these values" linenums="1"
66 | sonarqube - nofile 65536
67 | sonarqube - nproc 4096
68 | ```
69 | ### Increase Mapped Memory Regions
70 | ``` shell title="Run from shell prompt" linenums="1"
71 | sudo vim /etc/sysctl.conf
72 | ```
73 | Paste the below values at the bottom of the file
74 | ``` shell title="Add these values" linenums="1"
75 | vm.max_map_count = 262144
76 | ```
77 | ### Reboot System
78 | ``` shell title="Run from shell prompt" linenums="1"
79 | sudo reboot
80 | ```
81 | ## Sonarqube
82 | ### Download and Extract
83 | ``` shell title="Run from shell prompt" linenums="1"
84 | sudo wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-9.9.0.65466.zip
85 | sudo apt install unzip
86 | sudo unzip sonarqube-9.9.0.65466.zip -d /opt
87 | sudo mv /opt/sonarqube-9.9.0.65466 /opt/sonarqube
88 | ```
89 | ### Create user and set permissions
90 | ``` shell title="Run from shell prompt" linenums="1"
91 | sudo groupadd sonar
92 | sudo useradd -c "user to run SonarQube" -d /opt/sonarqube -g sonar sonar
93 | sudo chown sonar:sonar /opt/sonarqube -R
94 | ```
95 | ### Update Sonarqube properties with DB credentials
96 | ``` shell title="Run from shell prompt" linenums="1"
97 | sudo vim /opt/sonarqube/conf/sonar.properties
98 | ```
99 | Find and replace the below values, you might need to add the sonar.jdbc.url
100 | ``` shell title="Run from shell prompt" linenums="1"
101 | sonar.jdbc.username=sonar
102 | sonar.jdbc.password=sonar
103 | sonar.jdbc.url=jdbc:postgresql://localhost:5432/sonarqube
104 | ```
105 | Create service for Sonarqube
106 | ``` shell title="Run from shell prompt" linenums="1"
107 | sudo vim /etc/systemd/system/sonar.service
108 | ```
109 | Paste the below into the file
110 | ``` shell title="Paste the below contents" linenums="1"
111 | [Unit]
112 | Description=SonarQube service
113 | After=syslog.target network.target
114 |
115 | [Service]
116 | Type=forking
117 |
118 | ExecStart=/opt/sonarqube/bin/linux-x86-64/sonar.sh start
119 | ExecStop=/opt/sonarqube/bin/linux-x86-64/sonar.sh stop
120 |
121 | User=sonar
122 | Group=sonar
123 | Restart=always
124 |
125 | LimitNOFILE=65536
126 | LimitNPROC=4096
127 |
128 | [Install]
129 | WantedBy=multi-user.target
130 | ```
131 | Start Sonarqube and Enable service
132 | ``` shell title="Paste the below contents" linenums="1"
133 | sudo systemctl start sonar
134 | sudo systemctl enable sonar
135 | sudo systemctl status sonar
136 | ```
137 | Watch log files and monitor for startup
138 | ``` shell title="Watch logs" linenums="1"
139 | sudo tail -f /opt/sonarqube/logs/sonar.log
140 | ```
141 | Access the Sonarqube UI
142 | ``` shell title="Paste the below contents" linenums="1"
143 | http://:9000
144 | ```
145 |
146 | # Optional Reverse Proxy and TLS Configuration
147 |
148 | ## Installing Nginx
149 | ``` shell title="Run from shell prompt"
150 | sudo apt install nginx
151 | ```
152 |
153 | ``` shell title="create nginx config file" linenums="1"
154 | vi /etc/nginx/sites-available/sonarqube.conf
155 | ```
156 | Paste the contents below and be sure to update the domain name
157 |
158 | ``` shell title="Paste and update" linenums="1"
159 | server {
160 |
161 | listen 80;
162 | server_name sonarqube.dev.dman.cloud;
163 | access_log /var/log/nginx/sonar.access.log;
164 | error_log /var/log/nginx/sonar.error.log;
165 | proxy_buffers 16 64k;
166 | proxy_buffer_size 128k;
167 |
168 | location / {
169 | proxy_pass http://127.0.0.1:9000;
170 | proxy_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504;
171 | proxy_redirect off;
172 | proxy_set_header Host $host;
173 | proxy_set_header X-Real-IP $remote_addr;
174 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
175 | proxy_set_header X-Forwarded-Proto http;
176 | }
177 | }
178 | ```
179 | Next, activate the server block configuration 'sonarqube.conf' by creating a symlink of that file to the '/etc/nginx/sites-enabled' directory. Then, verify your Nginx configuration files.
180 |
181 | ``` shell title="Enable virtual host and restart nginx" linenums="1"
182 | sudo ln -s /etc/nginx/sites-available/sonarqube.conf /etc/nginx/sites-enabled/
183 | sudo nginx -t
184 | sudo systemctl restart nginx
185 | ```
186 |
187 | ## Installing Certbot
188 | The first step to using Let’s Encrypt to obtain an SSL certificate is to install the Certbot software on your server.
189 | ``` shell title="Run from shell prompt" linenums="1"
190 | sudo apt install certbot python3-certbot-nginx
191 | ```
192 |
193 | ### Obtaining an SSL Certificate
194 | Certbot provides a variety of ways to obtain SSL certificates through plugins. The Nginx plugin will take care of reconfiguring Nginx and reloading the config whenever necessary. To use this plugin, type the following:
195 | ``` shell title="Run from shell prompt (replace domain)" linenums="1"
196 | sudo certbot --nginx -d sonarqube.dev.dman.cloud
197 | ```
198 | If that’s successful, certbot will ask how you’d like to configure your HTTPS settings.
199 |
200 | Select your choice then hit ENTER. The configuration will be updated, and Nginx will reload to pick up the new settings. certbot will wrap up with a message telling you the process was successful and where your certificates are stored
201 |
202 | Nginx should now be serving your domain name. You can test this by navigating to https://your_domain
203 |
204 | That's it! You have now successfully installed Sonarque, if you found this tutotial helpful please consider subscribing to my YouTube Channel for more tutorials like this. https://www.youtube.com/@dineshmistry
205 |
--------------------------------------------------------------------------------
/docs/jenkins-in-kubernetes.md:
--------------------------------------------------------------------------------
1 | # Running Jenkins in Kubernetes (AWS)
2 | Installing Jenkins CI in Kubernests and building containers with Kaniko
3 | ## Prerequsites
4 | - Virtual Machine running Ubuntu 22.04 or newer
5 | ### Update Package Repository and Upgrade Packages
6 | ``` shell title="Run from shell prompt" linenums="1"
7 | sudo apt update
8 | sudo apt upgrade
9 | ```
10 | ## Create Kubernetes Cluster
11 | ``` shell title="Run from shell prompt" linenums="1"
12 | sudo bash
13 | curl -sfL https://get.k3s.io | INSTALL_K3S_EXEC="server" sh -s - --disable traefik
14 | exit
15 | mkdir .kube
16 | sudo cp /etc/rancher/k3s/k3s.yaml ./config
17 | sudo chown dmistry:dmistry config
18 | chmod 400 config
19 | export KUBECONFIG=~/.kube/config
20 | ```
21 |
22 | ## Installs Jenkins
23 | Install helm chart and update repo
24 | ``` shell title="Run from shell prompt" linenums="1"
25 | helm repo add jenkinsci https://charts.jenkins.io
26 | helm repo update
27 | ```
28 |
29 | ### Create Namespace
30 | ``` shell title="Run from shell prompt"
31 | kubectl create ns jenkins
32 | ```
33 |
34 | ### Download YAML files
35 | ``` shell title="Run from shell prompt"
36 | wget https://raw.githubusercontent.com/dmancloud/jenkins-kubernetes-kaniko/main/jenkins-sa.yaml
37 | wget https://raw.githubusercontent.com/dmancloud/jenkins-kubernetes-kaniko/main/jenkins-volume.yaml
38 | wget https://raw.githubusercontent.com/dmancloud/jenkins-kubernetes-kaniko/main/values.yaml
39 | ```
40 |
41 | ### Create a secret for Dockerhub
42 | ``` shell title="Run from shell prompt"
43 | kubectl create secret docker-registry docker-credentials --docker-username=[userid] --docker-password=[Docker Hub access token] --docker-email=[user email address] --namespace jenkins
44 | ```
45 | ### Finally install Jenkins CI
46 |
47 | ``` shell title="Run from shell prompt"
48 | helm upgrade --install jenkins jenkinsci/jenkins -n jenkins --create-namespace -f values.yaml
49 | ```
50 |
51 |
--------------------------------------------------------------------------------
/docs/jenkins-ssh-agent.md:
--------------------------------------------------------------------------------
1 | # Adding an SSH Based Agent to Jenkins
2 | ## Prerequsites
3 | - Virtual Machine running Ubuntu 22.04 or newer
4 | ### Update Package Repository and Upgrade Packages
5 |
6 | ``` shell title="Run from shell prompt" linenums="1"
7 | sudo apt update
8 | sudo apt upgrade
9 | ```
10 |
11 | ## Create Jenkins User
12 | ``` shell title="Run from shell prompt" linenums="1"
13 | sudo adduser jenkins
14 | ```
15 | Grant Sudo Rights to Jenkins User
16 | ``` shell title="Run from shell prompt" linenums="1"
17 | sudo usermod -aG sudo jenkins
18 | ```
19 | Logout and ssh back as user Jenkins
20 | ## Adoptium Java 11
21 | ``` shell title="Switch to root user" linenums="1"
22 | sudo bash
23 | ```
24 | ### Add Adoptium repository
25 | ``` shell title="Add adoptium repository" linenums="1"
26 | wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | tee /etc/apt/keyrings/adoptium.asc
27 | echo "deb [signed-by=/etc/apt/keyrings/adoptium.asc] https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | tee /etc/apt/sources.list.d/adoptium.list
28 | ```
29 | ### Install Java 11
30 | ``` shell title="Update repository and install Java" linenums="1"
31 | apt update
32 | apt install temurin-11-jdk
33 | update-alternatives --config java
34 | /usr/bin/java --version
35 | exit
36 | ```
37 | ## Docker
38 | ### Install using the repository
39 | Update the apt package index and install packages to allow apt to use a repository over HTTPS:
40 | ``` shell title="Run from shell prompt" linenums="1"
41 | sudo apt-get update
42 |
43 | sudo apt-get install \
44 | ca-certificates \
45 | curl \
46 | gnupg \
47 | lsb-release
48 | ```
49 | Add Docker’s official GPG key:
50 | ``` shell title="Run from shell prompt" linenums="1"
51 | sudo mkdir -m 0755 -p /etc/apt/keyrings
52 | curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
53 | ```
54 | Use the following command to set up the repository:
55 | ``` shell title="Run from shell prompt" linenums="1"
56 | echo \
57 | "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
58 | $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
59 | ```
60 | Install Docker Engine
61 | ``` shell title="Run from shell prompt" linenums="1"
62 | sudo apt-get update
63 | sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
64 | ```
65 | ### Manage Docker as a non-root user
66 | Create the docker group.
67 | ``` shell title="Run from shell prompt" linenums="1"
68 | sudo groupadd docker
69 | ```
70 | Add your user to the docker group.
71 | ``` shell title="Run from shell prompt" linenums="1"
72 | sudo usermod -aG docker $USER
73 | ```
74 | Run the following command to activate the changes to groups:
75 | ``` shell title="Run from shell prompt" linenums="1"
76 | newgrp docker
77 | ```
78 | Verify that you can run docker commands without sudo.
79 | ``` shell title="Run from shell prompt" linenums="1"
80 | docker run hello-world
81 | ```
82 |
83 | ## Connect to Remote SSH Agent
84 | From the Jenkins UI (Controller)
85 | ``` shell title="Run from shell prompt" linenums="1"
86 | ssh jenkins@$AGENT_HOSTNAME
87 | ```
88 | Create private and public SSH keys. The following command creates the private key jenkinsAgent_rsa and the public key jenkinsAgent_rsa.pub. It is recommended to store your keys under ~/.ssh/ so we move to that directory before creating the key pair.
89 | ``` shell title="Run from shell prompt" linenums="1"
90 | mkdir ~/.ssh; cd ~/.ssh/ && ssh-keygen -t rsa -m PEM -C "Jenkins agent key" -f "jenkinsAgent_rsa"
91 | ```
92 | Add the public SSH key to the list of authorized keys on the agent machine
93 | ``` shell title="Run from shell prompt" linenums="1"
94 | cat jenkinsAgent_rsa.pub >> ~/.ssh/authorized_keys
95 | ```
96 | Ensure that the permissions of the ~/.ssh directory is secure, as most ssh daemons will refuse to use keys that have file permissions that are considered insecure:
97 | ``` shell title="Run from shell prompt" linenums="1"
98 | chmod 700 ~/.ssh
99 | chmod 600 ~/.ssh/authorized_keys ~/.ssh/jenkinsAgent_rsa
100 | ```
101 | Copy the private SSH key (~/.ssh/jenkinsAgent_rsa) from the agent machine to your OS clipboard
102 | ``` shell title="Run from shell prompt" linenums="1"
103 | cat ~/.ssh/jenkinsAgent_rsa
104 | ```
105 |
106 | Now you can add the Agent on the Jenkins UI (Controller)
--------------------------------------------------------------------------------
/docs/jenkins-ssl.md:
--------------------------------------------------------------------------------
1 | # Configure Jenkins with SSL Using an Nginx Reverse Proxy
2 | By default, Jenkins comes with its own built-in Winstone web server listening on port 8080, which is convenient for getting started. It’s also a good idea, however, to secure Jenkins with SSL to protect passwords and sensitive data transmitted through the web interface.
3 | ## Prerequsites
4 | - Jenkins installed
5 | - An A record with pointing to your server’s public IP address.
6 | ### Update Package Repository and Upgrade Packages
7 | ``` shell title="Run from shell prompt" linenums="1"
8 | sudo apt update
9 | sudo apt upgrade
10 | ```
11 | ## Installing Certbot
12 | The first step to using Let’s Encrypt to obtain an SSL certificate is to install the Certbot software on your server.
13 | ``` shell title="Run from shell prompt" linenums="1"
14 | sudo apt install certbot python3-certbot-nginx
15 | ```
16 | ### Confirming Nginx’s Configuration
17 | Certbot needs to be able to find the correct server block in your Nginx configuration for it to be able to automatically configure SSL. Specifically, it does this by looking for a server_name directive that matches the domain you request a certificate for.
18 | ``` shell title="Run from shell prompt (replace domain)" linenums="1"
19 | sudo vi /etc/nginx/sites-available/jenkins.dev.dman.cloud
20 | ```
21 | Find the existing server_name line. It should look like this:
22 | ``` shell title="Look for your domain"
23 | ...
24 | server_name jenkins.dev.dman.cloud;
25 | ...
26 | ```
27 | If it does, exit your editor and move on to the next step. If not review the installing Nginx Tutorial
28 | ### Obtaining an SSL Certificate
29 | Certbot provides a variety of ways to obtain SSL certificates through plugins. The Nginx plugin will take care of reconfiguring Nginx and reloading the config whenever necessary. To use this plugin, type the following:
30 | ``` shell title="Run from shell prompt (replace domain)" linenums="1"
31 | sudo certbot --nginx -d jenkins.dev.dman.cloud
32 | ```
33 | If that’s successful, certbot will ask how you’d like to configure your HTTPS settings.
34 |
35 | Select your choice then hit ENTER. The configuration will be updated, and Nginx will reload to pick up the new settings. certbot will wrap up with a message telling you the process was successful and where your certificates are stored:
36 |
37 | ### Verifying Certbot Auto-Renewal
38 | Let’s Encrypt’s certificates are only valid for ninety days. This is to encourage users to automate their certificate renewal process. The certbot package we installed takes care of this for us by adding a systemd timer that will run twice a day and automatically renew any certificate that’s within thirty days of expiration.
39 |
40 | You can query the status of the timer with `systemctl`:
41 | ``` shell title="Run from shell prompt" linenums="1"
42 | sudo systemctl status certbot.timer
43 | ```
44 | ``` shell title="Output should look like the below" linenums="1"
45 | Output
46 | ● certbot.timer - Run certbot twice daily
47 | Loaded: loaded (/lib/systemd/system/certbot.timer; enabled; vendor preset: enabled)
48 | Active: active (waiting) since Mon 2020-05-04 20:04:36 UTC; 2 weeks 1 days ago
49 | Trigger: Thu 2020-05-21 05:22:32 UTC; 9h left
50 | Triggers: ● certbot.service
51 | ```
52 | To test the renewal process, you can do a dry run with `certbot`:
53 | ``` shell title="Run from shell prompt" linenums="1"
54 | sudo certbot renew --dry-run
55 | ```
56 | If you see no errors, you’re all set. When necessary, Certbot will renew your certificates and reload Nginx to pick up the changes. If the automated renewal process ever fails, Let’s Encrypt will send a message to the email you specified, warning you when your certificate is about to expire.
57 |
58 | Nginx should now be serving your domain name. You can test this by navigating to https://your_domain
--------------------------------------------------------------------------------
/docs/k3sup-ha.md:
--------------------------------------------------------------------------------
1 | # Lightweight HA Kubernetes with k3s & kube-vip
2 | ## Perfect kuberntes cluster for homelabs
3 |
4 | - k3s is lightweight kubernetes, easy to install, 50% memory, single binary of less than 100 MB.
5 | - kube-vip provides kubernetes clusters with a virtual IP for the control plane
6 | - k3sup is a light-weight utility to get from zero to KUBECONFIG with k3s on any local or remote VM
7 | ## Prerequsites
8 |
9 | !!! info "System Requirements"
10 | Five (5) linux virtual machines with statically configured IPs. It is recommended that the virtual machines have an **A Record** pointing to the IP address of the host.
11 |
12 | A floating IP Address for the Virtual IP to access the cluster. It is recommended that to have an **A Record** pointing to the floating IP Address.
13 |
14 | You will also need a linux host that you will deploy the server and agent nodes from.
15 |
16 | ## Install k3sup
17 | First you will need to install k3sup which is what we will use to deploy the server and agent nodes from.
18 |
19 | ``` shell title="Install k3sup"
20 | curl -sLS https://get.k3sup.dev | sh
21 | sudo install k3sup /usr/local/bin/
22 |
23 | k3sup --help
24 | ```
25 | k3sup uses ssh to connect to the server and agent nodes so we need to copy our public key.
26 |
27 | ``` shell title="copy ssh key to server node 1"
28 | ssh-copy-id dmistry@192.168.1.21
29 | ```
30 | ``` shell title="copy ssh key to server node 2"
31 | ssh-copy-id dmistry@192.168.1.22
32 | ```
33 | ``` shell title="copy ssh key to server node 3"
34 | ssh-copy-id dmistry@192.168.1.23
35 | ```
36 | ``` shell title="copy ssh key to agent node 1"
37 | ssh-copy-id dmistry@192.168.1.24
38 | ```
39 | ``` shell title="copy ssh key to agent node 1"
40 | ssh-copy-id dmistry@192.168.1.25
41 | ```
42 |
43 | Next we deploy a k3s sever node to the first node
44 |
45 | ``` shell linenums="1"
46 | k3sup install --ip 192.168.1.21 \
47 | --user dmistry \
48 | --sudo \
49 | --tls-san 192.168.1.20 \
50 | --cluster --local-path ~/.kube/k8s-cluster.dev.dman.cloud.yaml \
51 | --context k8s-cluster-ha \
52 | --k3s-extra-args "--disable traefik --disable servicelb --node-ip=192.168.1.21"
53 | ```
54 | ``` shell
55 | export KUBECONFIG=~/.kube/k8s-cluster.dev.dman.cloud.yaml
56 | ```
57 |
58 | ``` shell
59 | kubectl apply -f https://kube-vip.io/manifests/rbac.yaml
60 | ```
61 | SSH in to the first server node and install kube-vip
62 | ``` shell
63 | ssh 192.168.1.21
64 | ```
65 | ``` shell
66 | sudo -i
67 | ```
68 | ``` shell
69 | ctr image pull docker.io/plndr/kube-vip:latest
70 | ```
71 | ``` shell
72 | alias kube-vip="ctr run --rm --net-host docker.io/plndr/kube-vip:latest vip /kube-vip"
73 | ```
74 | ``` shell linenums="1"
75 | kube-vip manifest daemonset \
76 | --arp \
77 | --interface ens192 \
78 | --address 192.168.1.20 \
79 | --controlplane \
80 | --leaderElection \
81 | --taint \
82 | --inCluster | tee /var/lib/rancher/k3s/server/manifests/kube-vip.yaml
83 | ```
84 | Logout of first server node and join serves node 2 and server node 3
85 |
86 | ``` shell title="Server Node 2"
87 | k3sup join --ip 192.168.1.22 --user dmistry --sudo --k3s-channel stable --server --server-ip 192.168.1.20 --server-user dmistry --sudo --k3s-extra-args "--disable traefik --disable servicelb --node-ip=192.168.1.22"
88 | ```
89 | ``` shell title="Server Node 3"
90 | k3sup join --ip 192.168.1.23 --user dmistry --sudo --k3s-channel stable --server --server-ip 192.168.1.20 --server-user dmistry --sudo --k3s-extra-args "--disable traefik --disable servicelb --node-ip=192.168.1.23"
91 | ```
92 | Next we configure the agent nodes
93 | ``` shell title="Agent Node 2"
94 | k3sup join --user dmistry --sudo --server-ip 192.168.1.20 --ip 192.168.1.24 --k3s-channel stable -- --k3s-extra-args "--disable traefik --disable servicelb" --print-command
95 | ```
96 | ``` shell title="Agent Node 2"
97 | k3sup join --user dmistry --sudo --server-ip 192.168.1.20 --ip 192.168.1.25 --k3s-channel stable -- --k3s-extra-args "--disable traefik --disable servicelb" --print-command
98 | ```
99 |
100 | You can now download the kubeconfig from server node 1 and update the IP adderss to match the load balancer IP (192.168.1.20)
101 |
102 |
103 |
104 |
105 |
106 |
--------------------------------------------------------------------------------
/docs/kubernetes-certifcates-traefik.md:
--------------------------------------------------------------------------------
1 | # TLS Certifcates on Kubernetes with Traefik and Cloudflare
2 |
3 | In this tutorial we will deploy Traefik as our ingress controller and use Cloudflare and Let's Encrypt to secure our applications running in our kubernetes clusters
4 |
5 | ## Prerequsites
6 | - Kubernetes Cluster
7 | - Helm installed
8 |
9 | If you have not already done so make sure you have exported your kubeconig so you can access the cluster
10 |
11 | ``` shell title="export your kubeconfig" linenums="1"
12 | export KUBECONFIG=/home/dmistry/.kube/k8s-cluster.dev.dman.cloud.yaml
13 | ```
14 |
15 | ## Clone Repository
16 | ``` shell title="export your kubeconfig" linenums="1"
17 | git clone git@github.com:dmancloud/traefik-cert-manager.git
18 | ```
19 |
20 | ## Install Traefik Ingress Controller
21 | ``` shell title="export your kubeconfig" linenums="1"
22 | helm repo add traefik https://helm.traefik.io/traefik
23 | ```
24 |
25 | Update and make any changes need to the values file. If yo want to fetch the complete values and make additional adjustments you can do so by running the following command
26 | ``` shell title="export your kubeconfig" linenums="1"
27 | helm show values traefik/traefik > /tmp/values.yaml
28 | ```
29 | Install Traefik
30 | ``` shell title="export your kubeconfig" linenums="1"
31 | helm install --namespace=traefik traefik traefik/traefik --values=values.yaml
32 | ```
33 | Add default header values needed by most applications
34 | ``` shell title="export your kubeconfig" linenums="1"
35 | kubectl apply -f default-headers.yaml
36 | ```
37 |
38 | ## Install Cert-Manager
39 | ``` shell title="export your kubeconfig" linenums="1"
40 | helm repo add jetstack https://charts.jetstack.io
41 | ```
42 | ``` shell title="export your kubeconfig" linenums="1"
43 | helm upgrade --install \
44 | cert-manager jetstack/cert-manager \
45 | --namespace cert-manager \
46 | --create-namespace \
47 | --version v1.11.0 \
48 | --set installCRDs=true \
49 | --values=values.yaml \
50 | --create-namespace
51 | ```
52 |
53 | Next we need to create an API token on CloudFlare so we can create a secret for Lets Encrypt to use. Edit the `secret-cf-token.yaml` and replace the `cloudflare-token: ` with your token.
54 |
55 | When creating your token on Cloudflare you need to make sure you grant `edit` access to the token
56 |
57 | ``` shell title="export your kubeconfig" linenums="1"
58 | kubectl apply -f secret-cf-token.yaml
59 | ```
60 |
61 | Create ClusterIssuer you should start with a Staging Certificate before moving to Production certifcates to avoid any rate limiting in case you make a mistake.
62 |
63 | Edit the `letsencrypt-staging.yaml` and `letsencrypt-production.yaml` files and adjust to match your setup
64 | ``` shell title="export your kubeconfig" linenums="1"
65 | kubectl apply -f letsencrypt-staging.yaml
66 | kubectl apply -f letsencrypt-production.yaml
67 | ```
68 | ## Create Certificate for you Service (nginx)
69 |
70 | Next we will want to create a certificate for your service, you will need to make sure that you have created a DNS entry for your FQDN.
71 | ``` shell title="export your kubeconfig" linenums="1"
72 | kubectl apply -f nginx-dev.dman-cloud.yaml
73 | ```
74 |
75 | ## Deploy your application and configure IngressRoute
76 | In this example we will deploy nginx and create a simple IngressRoute
77 |
78 | ``` shell title="export your kubeconfig" linenums="1"
79 | kubectl apply -f deployment.yaml
80 | kubectl apply -f service.yaml
81 | ```
82 |
83 | Next we will deploy an IngressRoute be sure to edit the `ingress.yaml` and make any adjustments like your domain name, tls certifcate etc
84 |
85 | ``` shell title="export your kubeconfig" linenums="1"
86 | kubectl apply -f ingress.yaml
87 | ```
--------------------------------------------------------------------------------
/docs/nexus3-with-tls.md:
--------------------------------------------------------------------------------
1 | # Install Nexus3 Repository Manager with TLS
2 | Manage components, binaries and build artifacts across your entire software supply chain.
3 | ## Prerequsites
4 | - Virtual Machine running Ubuntu 22.04 or newer
5 | ### Update Package Repository and Upgrade Packages
6 |
7 | ``` shell title="Run from shell prompt" linenums="1"
8 | sudo apt update
9 | sudo apt upgrade
10 | ```
11 | ## Adoptium Temurin Java 8
12 | ``` shell title="Switch to root user" linenums="1"
13 | sudo bash
14 | ```
15 | ### Add Adoptium repository
16 | ``` shell title="Add adoptium repository" linenums="1"
17 | wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | tee /etc/apt/keyrings/adoptium.asc
18 | echo "deb [signed-by=/etc/apt/keyrings/adoptium.asc] https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | tee /etc/apt/sources.list.d/adoptium.list
19 | ```
20 | ### Install Java 8
21 | ``` shell title="Update repository and install Java" linenums="1"
22 | apt update
23 | apt install temurin-8-jdk
24 | ```
25 | ``` shell title="Check the Java Version is installed correctly" linenums="1"
26 | /usr/bin/java -version
27 | exit
28 | ```
29 |
30 | ## Install Nexus3 Repository Manager
31 | At time of writing v3.49.0 is the latest version. You can check if there is a newer version available by visiting - https://help.sonatype.com/repomanager3/product-information/download
32 |
33 | ### Download Nexus
34 |
35 | ``` shell title="Run from shell prompt" linenums="1"
36 | wget https://download.sonatype.com/nexus/3/nexus-3.49.0-02-unix.tar.gz
37 | ```
38 |
39 | ### Extract Nexus
40 | ``` shell title="Run from shell prompt" linenums="1"
41 | sudo tar -xzvf nexus-3.49.0-02-unix.tar.gz -C /opt
42 | ```
43 | ``` shell title="Run from shell prompt" linenums="1"
44 | cd /opt
45 | ```
46 | ``` shell title="Run from shell prompt" linenums="1"
47 | sudo mv nexus-3.49.0-02 nexus
48 | ```
49 |
50 | ### Create User to run Nexus3
51 | ``` shell title="Run from shell prompt" linenums="1"
52 | sudo adduser nexus
53 | ```
54 | ### Update and Grant Permissions to Nexus user
55 | ``` shell title="Run from shell prompt" linenums="1"
56 | sudo chown -R nexus:nexus /opt/nexus
57 | sudo chown -R nexus:nexus /opt/sonatype-work
58 | ```
59 | ### Change default run_as user
60 | ``` shell title="Run from shell prompt" linenums="1"
61 | sudo vi /opt/nexus/bin/nexus.rc
62 | ```
63 | Uncomment `#run_as_user=` and modify to set nexus as user. It should read `run_as_user=”nexus”`
64 |
65 | ### Configure Nexus to run as a service
66 | ``` shell title="Run from shell prompt" linenums="1"
67 | sudo vi /etc/systemd/system/nexus.service
68 | ```
69 | ``` shell title="Paste the below" linenums="1"
70 | [Unit]
71 | Description=nexus service
72 | After=network.target
73 |
74 | [Service]
75 | Type=forking
76 | LimitNOFILE=65536
77 | User=nexus
78 | Group=nexus
79 | ExecStart=/opt/nexus/bin/nexus start
80 | ExecStop=/opt/nexus/bin/nexus stop
81 | User=nexus
82 | Restart=on-abort
83 | [Install]
84 | WantedBy=multi-user.target
85 | ```
86 | ### Start and Enable Nexus
87 | ``` shell title="Run from shell prompt" linenums="1"
88 | sudo systemctl enable nexus
89 | ```
90 | ``` shell title="Run from shell prompt" linenums="1"
91 | sudo systemctl start nexus
92 | ```
93 | ``` shell title="Run from shell prompt" linenums="1"
94 | sudo systemctl status nexus
95 | ```
96 | ### Monitor Startup
97 | ``` shell title="Run from shell prompt" linenums="1"
98 | tail -f /opt/sonatype-work/nexus3/log/nexus.log
99 | ```
100 | Wait until you see Nexus3 has started, you should see something like below
101 | ``` shell title="Run from shell prompt" linenums="1"
102 | Started @50347ms
103 | 2023-03-14 13:36:15,995+0000 INFO [jetty-main-1] *SYSTEM org.sonatype.nexus.bootstrap.jetty.JettyServer -
104 | -------------------------------------------------
105 |
106 | Started Sonatype Nexus OSS 3.49.0-02
107 |
108 | -------------------------------------------------
109 | ```
110 | ### Access User Interface
111 | Once Nexus is successfully installed, you can access it in the browser by
112 | ``` shell title="Run from shell prompt" linenums="1"
113 | http://IP_Address:8081
114 | ```
115 |
116 | You can obtain the initial password by issuing the following command:
117 | ``` shell title="Run from shell prompt" linenums="1"
118 | cat /opt/sonatype-work/nexus3/admin.password
119 | ```
120 | ```
121 | Configure Nexus Docker Hosted Registry from the User Interface
122 | In the example below we are assuming a docker hosted registry
123 | was created on port 1111
124 | ```
125 | ## Installing Nginx
126 | ``` shell title="Run from shell prompt" linenums="1"
127 | sudo apt install nginx
128 | ```
129 | ### Checking your Web Server
130 | We can check with the `systemd` init system to make sure the service is running by typing:
131 | ``` shell title="Run from shell prompt" linenums="1"
132 | systemctl status nginx
133 | ```
134 | We can check with the systemd init system to make sure the service is running by typing:
135 | ``` console title="Output should look similar to the below" linenums="1"
136 | Output
137 | ● nginx.service - A high performance web server and a reverse proxy server
138 | Loaded: loaded (/lib/systemd/system/nginx.service; enabled; vendor preset: enabled)
139 | Active: active (running) since Fri 2020-04-20 16:08:19 UTC; 3 days ago
140 | Docs: man:nginx(8)
141 | Main PID: 2369 (nginx)
142 | Tasks: 2 (limit: 1153)
143 | Memory: 3.5M
144 | CGroup: /system.slice/nginx.service
145 | ├─2369 nginx: master process /usr/sbin/nginx -g daemon on; master_process on;
146 | └─2380 nginx: worker process
147 | ```
148 |
149 | Check you Web Server is running
150 | ``` shell title="Access your web server by visiting"
151 | http://your_server_ip
152 | ```
153 | In order for Nginx to serve this content, it’s necessary to create a server block with the correct directives.
154 | ``` shell title="Run from shell prompt (replace your domain)" linenums="1"
155 | sudo vi /etc/nginx/sites-available/nexus-repo.dev.dman.cloud
156 | ```
157 | Paste in the following configuration block, which is similar to the default, but updated for our new directory and domain name:
158 | ``` shell title="Paste the below (replace your domain)" linenums="1"
159 |
160 |
161 | server {
162 | listen *:80;
163 | server_name nexus-repo.dev.dman.cloud;
164 |
165 | # allow large uploads of files - refer to nginx documentation
166 | client_max_body_size 1G;
167 |
168 | # optimize downloading files larger than 1G - refer to nginx doc before adjusting
169 | #proxy_max_temp_file_size 2G;
170 |
171 | location / {
172 | proxy_pass http://127.0.0.1:8081;
173 | proxy_set_header Host $host;
174 | proxy_set_header X-Real-IP $remote_addr;
175 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
176 | }
177 |
178 | # Docker /v2 and /v1 (for search) requests
179 | location /v2 {
180 | proxy_set_header Host $host:$server_port;
181 | proxy_set_header X-Real-IP $remote_addr;
182 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
183 | proxy_pass http://127.0.0.1:1111;
184 | }
185 | location /v1 {
186 | proxy_set_header Host $host:$server_port;
187 | proxy_set_header X-Real-IP $remote_addr;
188 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
189 | proxy_pass http://127.0.0.1:1111;
190 | }
191 | }
192 | ```
193 |
194 | Next, let’s enable the file by creating a link from it to the sites-enabled directory, which Nginx reads from during startup:
195 | ``` shell title="Run from shell prompt (replace your domain)" linenums="1"
196 | sudo ln -s /etc/nginx/sites-available/nexus-repo.dev.dman.cloud /etc/nginx/sites-enabled/
197 | ```
198 | Next, test to make sure that there are no syntax errors in any of your Nginx files:
199 | ``` shell title="Run from shell prompt" linenums="1"
200 | sudo nginx -t
201 | ```
202 | If there aren’t any problems, restart Nginx to enable your changes:
203 | ``` shell title="Run from shell prompt" linenums="1"
204 | sudo systemctl restart nginx
205 | ```
206 | Nginx should now be serving Nexus from your domain name. You can test this by navigating to http://your_domain
207 |
208 |
209 | ## Configure Nexus with SSL Using an Nginx Reverse Proxy
210 | By default, Jenkins comes with its own built-in Winstone web server listening on port 8080, which is convenient for getting started. It’s also a good idea, however, to secure Jenkins with SSL to protect passwords and sensitive data transmitted through the web interface.
211 |
212 | ### Installing Certbot
213 | The first step to using Let’s Encrypt to obtain an SSL certificate is to install the Certbot software on your server.
214 | ``` shell title="Run from shell prompt" linenums="1"
215 | sudo apt install certbot python3-certbot-nginx
216 | ```
217 | ### Confirming Nginx’s Configuration
218 | Certbot needs to be able to find the correct server block in your Nginx configuration for it to be able to automatically configure SSL. Specifically, it does this by looking for a server_name directive that matches the domain you request a certificate for.
219 | ``` shell title="Run from shell prompt (replace domain)" linenums="1"
220 | sudo vi /etc/nginx/sites-available/nexus-repo.dev.dman.cloud
221 | ```
222 | Find the existing server_name line. It should look like this:
223 | ``` shell title="Look for your domain"
224 | ...
225 | server_name nexus-repo.dev.dman.cloud;
226 | ...
227 | ```
228 | If it does, exit your editor and move on to the next step. If not review the installing Nginx Tutorial
229 | ### Obtaining an SSL Certificate
230 | Certbot provides a variety of ways to obtain SSL certificates through plugins. The Nginx plugin will take care of reconfiguring Nginx and reloading the config whenever necessary. To use this plugin, type the following:
231 | ``` shell title="Run from shell prompt (replace domain)" linenums="1"
232 | sudo certbot --nginx -d nexus-repo.dev.dman.cloud
233 | ```
234 | If that’s successful, certbot will ask how you’d like to configure your HTTPS settings.
235 |
236 | Select your choice then hit ENTER. The configuration will be updated, and Nginx will reload to pick up the new settings. certbot will wrap up with a message telling you the process was successful and where your certificates are stored:
237 |
238 | ### Verifying Certbot Auto-Renewal
239 | Let’s Encrypt’s certificates are only valid for ninety days. This is to encourage users to automate their certificate renewal process. The certbot package we installed takes care of this for us by adding a systemd timer that will run twice a day and automatically renew any certificate that’s within thirty days of expiration.
240 |
241 | You can query the status of the timer with `systemctl`:
242 | ``` shell title="Run from shell prompt" linenums="1"
243 | sudo systemctl status certbot.timer
244 | ```
245 | ``` shell title="Output should look like the below" linenums="1"
246 | Output
247 | ● certbot.timer - Run certbot twice daily
248 | Loaded: loaded (/lib/systemd/system/certbot.timer; enabled; vendor preset: enabled)
249 | Active: active (waiting) since Mon 2020-05-04 20:04:36 UTC; 2 weeks 1 days ago
250 | Trigger: Thu 2020-05-21 05:22:32 UTC; 9h left
251 | Triggers: ● certbot.service
252 | ```
253 | To test the renewal process, you can do a dry run with `certbot`:
254 | ``` shell title="Run from shell prompt" linenums="1"
255 | sudo certbot renew --dry-run
256 | ```
257 | If you see no errors, you’re all set. When necessary, Certbot will renew your certificates and reload Nginx to pick up the changes. If the automated renewal process ever fails, Let’s Encrypt will send a message to the email you specified, warning you when your certificate is about to expire.
258 |
259 | Nginx should now be serving your domain name. You can test this by navigating to https://your_domain
--------------------------------------------------------------------------------
/docs/rancher-manager-with-lets-encrypt.md:
--------------------------------------------------------------------------------
1 | # Install Rancher Manager With Lets Encrypt
2 | Rancher is a popular open-source platform for managing and deploying containerized applications on Kubernetes. By using cert-manager and Let's Encrypt, we will ensure that all communication with the Rancher server is secure and encrypted.
3 | ## Prerequsites
4 | - Domain Name
5 | - Ability to make DNS Changes
6 | - Ubuntu Virtual Machine
7 | - Port 80 & 443 must be accessible for Let's Encrypt to verify and issue certificates
8 |
9 | ## Configure DNS
10 | Pick a subdomain and create a DNS entry pointing to the IP Address that will be assigned to the Rancher Server
11 | ``` shell title="Run from shell prompt" linenums="1"
12 | curl -4 icanhazip.com
13 | ```
14 | Head over to your DNS Provider and create an ````A```` record
15 | ``` shell title="Run from shell prompt" linenums="1"
16 | dig +short replace_with_subdomain
17 | ```
18 |
19 | ## Update Package Repository and Upgrade Packages
20 | ``` shell title="Run from shell prompt" linenums="1"
21 | sudo apt-get update && sudo apt upgrade -y
22 | ```
23 | ## Install required packages
24 | ``` shell title="Run from shell prompt" linenums="1"
25 | sudo apt-get -y install gnupg2 ca-certificates curl apt-transport-https iptables
26 | ```
27 |
28 | ### Install Helm v3
29 | Additional Information - https://helm.sh/docs/intro/install/
30 | ``` shell title="Run from shell prompt" linenums="1"
31 | curl https://baltocdn.com/helm/signing.asc | gpg --dearmor | sudo tee /usr/share/keyrings/helm.gpg > /dev/null
32 | sudo apt-get install apt-transport-https --yes
33 | echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/helm.gpg] https://baltocdn.com/helm/stable/debian/ all main" | sudo tee /etc/apt/sources.list.d/helm-stable-debian.list
34 | sudo apt-get update
35 | sudo apt-get install helm
36 | ```
37 |
38 | ### Install kubectl
39 | Additional Information - https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/
40 | ``` shell title="Run from shell prompt" linenums="1"
41 | sudo apt update
42 | sudo apt install ca-certificates curl apt-transport-https -y
43 | sudo curl -fsSLo /usr/share/keyrings/kubernetes-archive-keyring.gpg https://packages.cloud.google.com/apt/doc/apt-key.gpg
44 | echo "deb [signed-by=/usr/share/keyrings/kubernetes-archive-keyring.gpg] https://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee /etc/apt/sources.list.d/kubernetes.list
45 | sudo apt update
46 | sudo apt install kubectl -y
47 | ```
48 |
49 | ## Install RKE2 Cluster
50 | Additional Information - https://docs.rke2.io/
51 | ``` shell title="Run from shell prompt" linenums="1"
52 | sudo bash
53 | curl -sfL https://get.rke2.io | sh -
54 | exit
55 | ```
56 | ``` shell title="Run from shell prompt" linenums="1"
57 | sudo systemctl enable rke2-server.service
58 | sudo systemctl start rke2-server.service
59 | sudo journalctl -u rke2-server -f
60 | mkdir ~/.kube
61 | sudo cp /etc/rancher/rke2/rke2.yaml ~/.kube/config
62 | sudo chown $USER:$USER ~/.kube/config
63 | chmod 400 ~/.kube/config
64 | kubectl get pods -A
65 | ```
66 |
67 | ### Install cert-manager
68 | Additional Information - https://cert-manager.io/docs/installation/
69 | ``` shell title="Run from shell prompt" linenums="1"
70 | helm repo add jetstack https://charts.jetstack.io
71 | helm repo update
72 | helm upgrade --install cert-manager jetstack/cert-manager --namespace cert-manager --create-namespace --set installCRDs=true
73 | ```
74 | ### Install Rancher
75 | Additional Information - https://docs.ranchermanager.rancher.io/
76 | ``` shell title="Run from shell prompt" linenums="1"
77 | kubectl create ns cattle-system
78 | helm repo add rancher-latest https://releases.rancher.com/server-charts/latest
79 | helm repo update
80 | helm install rancher rancher-latest/rancher --namespace cattle-system --set hostname=HOSTNAME --set bootstrapPassword=PASSWORD --set ingress.tls.source=letsEncrypt --set letsEncrypt.email=EMAIL_ADDRESS --set letsEncrypt.ingress.class=nginx
81 | kubectl -n cattle-system rollout status deploy/rancher
82 | watch kubectl get pods -A
83 | ```
84 | ### Access Rancher User Interface
85 | ``` shell title="Open in browser" linenums="1"
86 | https://RANCHER_URL
87 | ```
--------------------------------------------------------------------------------
/docs/truenas-core-tls.md:
--------------------------------------------------------------------------------
1 | # TrueNAS (Core) Configure TLS Certificate
2 |
3 | The first step is to update your network setting. Make sure you have a static IP address and update the hostname and domain you will need to change it to a Fully Qualified Domain Name (FQDN).
4 |
5 | ``` shell
6 | truenas.dev.dman.cloud
7 | ```
8 |
9 | ## Install acme.sh shell script using the below command
10 | Open a shell to your TrueNAS server
11 |
12 | ``` shell
13 | curl https://get.acme.sh | sh -s email=xxxxxx@xxxxx.xxx
14 | ```
15 | Next you will need to use the ACME DNS API wiki to determine what the correct syntax for your Domain service provider
16 |
17 | ``` shell
18 | https://github.com/acmesh-official/acme.sh/wiki/dnsapi
19 | ```
20 |
21 | The syntax below is for CloudFlare
22 |
23 | ``` shell
24 | export CF_Token="sdfsdfsdfljlbjkljlkjsdfoiwje"
25 | export CF_Account_ID="xxxxxxxxxxxxx"
26 | ```
27 |
28 | In order to use the new token, the token currently needs access read access to Zone.Zone, and write access to Zone.DNS, across all Zones.
29 |
30 | The next step is to request a certificate from Let’s Encrypt
31 |
32 | ``` shell
33 | acme.sh --issue --dns dns_cf --keylength 4096 -d truenas.dev.dman.cloud
34 | ```
35 | ## Create TrueNAS API Token
36 | Next, you will need to generate a API Key on TrueNAS to deploy the certificate. You can obtain a API Key from your TrueNAS console
37 |
38 | ## Clone the below repository
39 | This repository contains a python script which will help you install the TLS Certificate
40 |
41 | ``` shell
42 | git clone https://github.com/dmancloud/letsencrypt-truenas.git
43 | ```
44 | Once you’ve downloaded the script, you’ll need to create a configuration file called deploy_config. The git repo has an example (deploy_config.example) which you can copy and modify, or you can write your own from scratch.
45 |
46 | Insert your API key that you generated earlier
47 |
48 | ``` shell
49 | [deploy]
50 | api_key = CHANGE_ME
51 | ```
52 |
53 | Next, you will install the certificate using the below command
54 | ``` shell
55 | acme.sh --install-cert -d truenas.dev.dman.cloud --reloadcmd "~/letsencrypt-truenas/deploy_freenas.py"
56 | ```
57 |
58 | * note if you get an error make sure the python script has the executable permission `chmod a+x deploy_freenas.py`
59 |
60 | You shoulf see the message “Certificate import successfully.” Your Web Service will restart.
61 |
62 | ### Redirect http->https
63 | Log back into your console after the system restarted. Then, navigate to System Settings > GUI > Settings and enable Web Interface HTTP -> HTTPS Redirect.
64 |
65 | ``` shell
66 | It is a good idea to restart your TrueNas server again at this point
67 | ```
68 |
69 | Lastly, you need to create a Cron Job to renew the certificate automatically, we can check `weekly`
70 |
71 | ``` shell
72 | /root/.acme.sh/acme.sh --cron
73 | ```
74 | Congratulation, you have successfully deployed Let’s encrypt Certificate on your TrueNAS.
75 |
--------------------------------------------------------------------------------
/docs/versions.json:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/dmancloud/tutorial-documentation/4bc2f99c15a78458f438f8250a3d2beed87589e0/docs/versions.json
--------------------------------------------------------------------------------
/mkdocs.yml:
--------------------------------------------------------------------------------
1 | site_name: Dinesh Mistry Tutorials
2 | site_author: Dinesh Mistry
3 | site_description: >-
4 | Making DevOps accessible and easy to understand
5 |
6 | # Repository
7 | repo_name: tutorial-documentation
8 | repo_url: https://github.com/dmancloud/tutorial-documentation
9 |
10 | theme:
11 | name: material
12 | font:
13 | text: Roboto
14 | code: Roboto Mono
15 |
16 | favicon: assets/favicon.png
17 | icon:
18 | logo: logo
19 |
20 | # Plugins
21 | plugins:
22 | - search:
23 | separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
24 | - minify:
25 | minify_html: true
26 | - mkdocs-video
27 | - git-revision-date-localized:
28 | enable_creation_date: true
29 |
30 | palette:
31 |
32 | # Palette toggle for light mode
33 | - scheme: default
34 | toggle:
35 | icon: material/brightness-7
36 | name: Switch to dark mode
37 |
38 | # Palette toggle for dark mode
39 | - scheme: slate
40 | toggle:
41 | icon: material/brightness-4
42 | name: Switch to light mode
43 |
44 | features:
45 | - content.tooltips
46 | #- navigation.sections
47 | - navigation.tabs
48 | - navigation.top
49 | - navigation.footer
50 | - navigation.indexes
51 | - navigation.tracking
52 | #- navigation.expand
53 | - navigation.path
54 | - toc.follow
55 | - search.suggest
56 | - search.highlight
57 | - search.share
58 | - content.tabs.link
59 | - content.code.annotate
60 | - content.code.copy
61 |
62 | language: en
63 |
64 | extra:
65 | version:
66 | provider: mike
67 | default: latest
68 | annotate:
69 | json: [.s2]
70 | social:
71 | - icon: fontawesome/brands/github-alt
72 | link: https://github.com/dmancloud
73 | - icon: fontawesome/brands/twitter
74 | link: https://twitter.com/dineshmistry
75 | - icon: fontawesome/brands/docker
76 | link: https://hub.docker.com/u/dmancloud
77 | - icon: fontawesome/brands/youtube
78 | link: https://www.youtube.com/@dineshmistry?sub_confirmation=1
79 | generator: false
80 | consent:
81 | title: Cookie consent
82 | description: >-
83 | We use cookies to recognize your repeated visits and preferences, as well
84 | as to measure the effectiveness of our documentation and whether users
85 | find what they're searching for. With your consent, you're helping us to
86 | make our documentation better.
87 |
88 | # Extensions
89 | markdown_extensions:
90 | - abbr
91 | - admonition
92 | - attr_list
93 | - def_list
94 | - footnotes
95 | - md_in_html
96 | - tables
97 | - toc:
98 | permalink: true
99 | - pymdownx.arithmatex:
100 | generic: true
101 | - pymdownx.betterem:
102 | smart_enable: all
103 | - pymdownx.caret
104 | - pymdownx.details
105 | - pymdownx.emoji:
106 | emoji_generator: !!python/name:materialx.emoji.to_svg
107 | emoji_index: !!python/name:materialx.emoji.twemoji
108 | - pymdownx.highlight:
109 | anchor_linenums: true
110 | line_spans: __span
111 | pygments_lang_class: true
112 | - pymdownx.inlinehilite
113 | - pymdownx.keys
114 | - pymdownx.magiclink:
115 | repo_url_shorthand: true
116 | user: squidfunk
117 | repo: mkdocs-material
118 | - pymdownx.mark
119 | - pymdownx.smartsymbols
120 | - pymdownx.superfences:
121 | custom_fences:
122 | - name: mermaid
123 | class: mermaid
124 | format: !!python/name:pymdownx.superfences.fence_code_format
125 | - pymdownx.tabbed:
126 | alternate_style: true
127 | - pymdownx.tasklist:
128 | custom_checkbox: true
129 | - pymdownx.tilde
130 |
131 | copyright: |
132 | Copyright © 2023 Dinesh Mistry
133 |
134 | nav:
135 | - Home: index.md
136 | - Tutorials:
137 | - Jenkins:
138 | - Install Jenkins: install-jenkins.md
139 | - Install Nginx Reverse Proxy for Jenkins: install-nginx.md
140 | - Configure Jenkins with TLS: jenkins-ssl.md
141 | - Adding an SSH Based Agent with Docker to Jenkins: jenkins-ssh-agent.md
142 | - Install Jenkins on Kubernetes: jenkins-in-kubernetes.md
143 | - ArgoCD:
144 | - Install ArgoCD: install-argocd.md
145 | - ArgoCD Git Webhook: argocd-webhook.md
146 | - Kubernetes:
147 | - RKE2 Kubernetes HA with Kube-VIP: ha-kubernetes-cluster-with-rke2.md
148 | - k3s HA Kubernetes with k3sup: k3sup-ha.md
149 | - Kubernetes Secrets: howto-use-kubernetes-secrets.md
150 | - TLS Certifcates on Kubernetes & Cloudflare: kubernetes-certifcates-traefik.md
151 | - Rancher:
152 | - Install Rancher Manager With Lets Encrypt: rancher-manager-with-lets-encrypt.md
153 | - Install Sonarqube: install-sonarqube.md
154 | - Install Gitlab CE k8s: install-gitlab-ce-k8s.md
155 | - Install Nexus3 Repository Manager with TLS: nexus3-with-tls.md
156 | - TrueNAS (Core):
157 | - TrueNAS Core Configure TLS: truenas-core-tls.md
158 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | jinja2>=3.0
2 | markdown>=3.2
3 | mkdocs>=1.4.2
4 | mkdocs-material-extensions>=1.1
5 | pygments>=2.14
6 | pymdown-extensions>=9.9.1
7 |
8 | # Requirements for plugins
9 | colorama>=0.4
10 | regex>=2022.4.24
11 | requests>=2.26
12 | mike
--------------------------------------------------------------------------------