diff --git a/docs/about.md b/docs/about.md deleted file mode 100644 index 672eeda..0000000 --- a/docs/about.md +++ /dev/null @@ -1,3 +0,0 @@ -# This is my first title - -And this is my first content, yeah diff --git a/docs/apps/blog.md b/docs/apps/blog.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/apps/blog.md diff --git a/docs/apps/docs.md b/docs/apps/docs.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/apps/docs.md diff --git a/docs/apps/git.md b/docs/apps/git.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/apps/git.md diff --git a/docs/apps/www.md b/docs/apps/www.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/apps/www.md diff --git a/docs/auth/kerberos.md b/docs/auth/kerberos.md deleted file mode 100644 index e69de29..0000000 --- a/docs/auth/kerberos.md +++ /dev/null diff --git a/docs/auth/openidc.md b/docs/auth/openidc.md deleted file mode 100644 index e69de29..0000000 --- a/docs/auth/openidc.md +++ /dev/null diff --git a/docs/auth/shell.md b/docs/auth/shell.md deleted file mode 100644 index e69de29..0000000 --- a/docs/auth/shell.md +++ /dev/null diff --git a/docs/auth/tls.md b/docs/auth/tls.md deleted file mode 100644 index 89454f8..0000000 --- a/docs/auth/tls.md +++ /dev/null @@ -1 +0,0 @@ -# TLS certificate auth diff --git a/docs/buildsys/git.md b/docs/buildsys/git.md new file mode 100644 index 0000000..bb5482b --- /dev/null +++ b/docs/buildsys/git.md @@ -0,0 +1 @@ +# Git source control diff --git a/docs/buildsys/mirror-network.md b/docs/buildsys/mirror-network.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/buildsys/mirror-network.md diff --git a/docs/buildsys/qa.md b/docs/buildsys/qa.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/buildsys/qa.md diff --git a/docs/img/favicon-centos.ico b/docs/img/favicon-centos.ico new file mode 100644 index 0000000..188bd11 Binary files /dev/null and b/docs/img/favicon-centos.ico differ diff --git a/docs/index.md b/docs/index.md index f747c25..0731b2c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,36 @@ # CentOS Infra and Releng documentation -This site is dedicated to CentOS Infrastructure documentation and is considered *Work in progress* +!!! note + This site is dedicated to CentOS Infrastructure documentation and is considered ***Work in progress*** + The goal is to consolidate various documentation[s] we have either through ansible inventories, some other git private repositories and/or elsewhere. -The goal is to consolidate various documentation we have either through ansible inventories, some other git private repositories and/or elsewhere. +This `CentOS Infra and Releng Documentation` site contains some explanations and SOPs (Standard Operating Procedure) *but* isn't a substitute for upsream documentation from all applications/components used in the CentOS Infra. So consider this a central place that will contain : + * pointers to upstream documentation (if existing) + * specific notes/details about how it's implemented in infra + * link[s] to Ansible Role[s] (which is/are really the `source of truth` on how app/infra is deployed and maintained) + +Also worth knowing that it will *not* contain any sensitive information, obviously only shared through `crypted` media between trusted CentOS infra team members (but it might contain though link to other online documentation or git repositories themselves needed some authentication/ACL in place at that level, so "out of scope" for this documentation) + +## Infra overview + +The CentOS infra is built on top of both : + + * [Red Hat](http://www.redhat.com) sponsored and hosted infrastructure (running critical services to build and deliver CentOS Linux / CentOS Stream / Special Interest Group[s] (SIG) content/artifacts + * [Community sponsored](https://www.centos.org/sponsors) infra with machines all around the world (mostly dedicated bare-metal machines) + +Feel free to browse all top-level sections to have a look at all services used/deployed within the CentOS infra. +Each section *should* contain (as noted above) : + + * pointers to upstream documentation (Read It First !) + * pointers to Ansible role covering it + * some URLs for the application (if any and/or public) + * level of access needed to configure/update/deploy it + * how the application/infra/service is monitored + * some SOPs for `daily/common` operations/tasks + +Worth also knowing that this site is automatically rendered from a [git repository](https://git.centos.org/centos/centos-infra-docs) (including also a way to render it locally to browse it through localhost) , so feel free to also submit Pull Request there if you find something that needs to be fixed/updated ! + +!!! tip + You can use the `search` feature/box on top level to search for some specific topics or keywords diff --git a/docs/infra/authentication.md b/docs/infra/authentication.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/infra/authentication.md diff --git a/docs/infra/centos-ci.md b/docs/infra/centos-ci.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/infra/centos-ci.md diff --git a/docs/infra/ec2.md b/docs/infra/ec2.md deleted file mode 100644 index e69de29..0000000 --- a/docs/infra/ec2.md +++ /dev/null diff --git a/docs/infra/mailservers.md b/docs/infra/mailservers.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/infra/mailservers.md diff --git a/docs/infra/monitoring.md b/docs/infra/monitoring.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/infra/monitoring.md diff --git a/docs/infra/web.md b/docs/infra/web.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/infra/web.md diff --git a/docs/operations/ci/index.md b/docs/operations/ci/index.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/operations/ci/index.md diff --git a/docs/operations/ci/ocp.md b/docs/operations/ci/ocp.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/operations/ci/ocp.md diff --git a/docs/operations/sponsored/bare-metal.md b/docs/operations/sponsored/bare-metal.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/operations/sponsored/bare-metal.md diff --git a/docs/operations/sponsored/ec2.md b/docs/operations/sponsored/ec2.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/operations/sponsored/ec2.md diff --git a/docs/security/gpg.md b/docs/security/gpg.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/security/gpg.md diff --git a/docs/security/index.md b/docs/security/index.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/security/index.md diff --git a/docs/tips/hardware.md b/docs/tips/hardware.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/tips/hardware.md diff --git a/docs/tips/ipmi.md b/docs/tips/ipmi.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/tips/ipmi.md diff --git a/mkdocs.yml b/mkdocs.yml index 17d4597..4b83d2d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,9 @@ site_name: CentOS Infra docs site_url: https://docs.infra.centos.org/ + +repo_url: https://git.centos.org/centos/centos-infra-docs +repo_name: centos/centos-infra-docs + nav: - Overview: index.md - Operations: @@ -11,21 +15,29 @@ nav: - operations/sponsored/bare-metal.md - operations/decommission.md - CI infra: - - test.md + - operations/ci/index.md + - operations/ci/ocp.md - Build and Delivery: + - buildsys/git.md - Build Systems: - - buildsys/reimzul.md - buildsys/koji-cbs.md - buildsys/koji-cbs-sigs.md - buildsys/koji-mbox.md - buildsys/koji-stream.md - - Pushing to mirror/CDN: + - buildsys/reimzul.md + - Validate: + - buildsys/qa.md + - Mirrors CDN: - buildsys/mirror-network.md - Public Applications: + - apps/www.md + - apps/git.md - apps/wiki.md - apps/bugs.md - apps/forums.md - apps/mailman.md + - apps/docs.md + - apps/blog.md - Infra services: - infra/authentication.md - infra/dns.md @@ -36,7 +48,9 @@ nav: - infra/centos-ci.md - infra/monitoring.md - Security: + - security/index.md - security/tls.md + - security/gpg.md - Ansible: - ansible/index.md - ansible/ara.md @@ -44,19 +58,23 @@ nav: - tips/mdadm.md - tips/hardware.md - tips/ipmi.md + theme: name: material logo: img/centos.png + favicon: img/favicon-centos.ico features: - navigation.tabs - - navigation.tabs.sticky - - navigation.sections + - navigation.expand - navigation.top + - toc.integrate palette: - primary: black + primary: indigo + accent: deep orange markdown_extensions: - toc: baselevel: 4 + permalink: true - admonition