Skip to content

Commit

Permalink
[EDP-DDM-26049] Added content to admin-overview.adoc for en and ua, a…
Browse files Browse the repository at this point in the history
…dded references subsections, updated admin/nav.adoc, added minor fixes to files

Change-Id: I012fea4b484ece6fd8e8ef6c2a6950ea528f0409
  • Loading branch information
[email protected] committed Sep 8, 2023
1 parent 2aaca30 commit 3f7035b
Show file tree
Hide file tree
Showing 8 changed files with 57 additions and 13 deletions.
24 changes: 23 additions & 1 deletion docs/en/modules/admin/pages/admin-overview.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,23 @@
= Platform administrators
:sectlinks:
= Platform administrators

The _Platform administrators_ section provides detailed instructions for the technical administrators of the Platform, covering all aspects of their operations, from installation to integration with external systems.

Here, you will find step-by-step installation and configuration guidelines, requirements for OKD clusters, and details on deploying the Platform in targeted environments. The section also delves into managing the Platform and its registries through the Control Plane administrative panel, overseeing registry resources, scaling, configuring digital signatures and certificates, DNS settings, technical maintenance of event logging and monitoring subsystems, and working with distributed file systems.

For those keen on a deeper understanding of the Platform's technical administrator role, a complete job manual outlines the technology stack, responsibilities, and requirements. Specific integration settings with external systems are also detailed, highlighting the importance of ensuring compatibility and flexibility of our Platform.

This section is an essential resource for technical professionals aiming to fully comprehend and efficiently manage our Platform.

== Section overview

* xref:admin:installation/overview.adoc[Installing and configuring]
* xref:admin:registry-management/overview.adoc[Managing the Platform and registries in the Control Plane]
* xref:admin:migrate-registry.adoc[Migrating registries]
* xref:admin:update/overview.adoc[Updating]
* xref:admin:backup-restore/overview.adoc[Backing up and restoring]
* xref:admin:scaling/overview.adoc[Scaling]
* xref:admin:logging/elastic-search.adoc[Technical maintenance of Event logging subsystem (EFK)]
* xref:admin:file-system/ceph-space.adoc[Managing the distributed file system]
* xref:platform:registry-develop:bp-modeling/bp/rest-connector.adoc#create-service-entry[Integrating with external systems]
* xref:admin:admin-study/admin-profile.adoc[Technical platform administrator: duties and responsibilities]
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ In this section, you can learn to:
** xref:registry-management/custom-dns/cp-custom-dns-portals.adoc[]
** xref:registry-management/custom-dns/cp-custom-dns-keycloak.adoc[]
* xref:registry-management/control-plane-cidr-access-endpoints.adoc[]
* xref:admin:registry-management/сontrol-plane-registry-resources.adoc[]
* xref:admin:registry-management/control-plane-registry-resources.adoc[]
* xref:admin:registry-management/control-plane-submit-mr.adoc[]
* xref:registry-management/control-plane-remove-registry.adoc[]
* xref:admin:registry-management/control-plane-quick-links.adoc[]
12 changes: 6 additions & 6 deletions docs/en/modules/admin/partials/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
**** xref:admin:registry-management/custom-dns/cp-custom-dns-keycloak.adoc[Configuring custom DNS for Keycloak]
*** xref:admin:registry-management/control-plane-cidr-access-endpoints.adoc[CIDR: Restricting access to Platform and registry components]
*** xref:admin:registry-management/control-plane-submit-mr.adoc[Approving registry configuration update requests]
*** xref:admin:registry-management/control-plane-digital-documents.adoc[Managing restrictions on digital document uploads]
*** xref:admin:registry-management/control-plane-quick-links.adoc[Quick links to registry services]
// ===================== MIGRATING REGISTRIES ========================
+
Expand All @@ -42,8 +43,7 @@
*** xref:admin:update/certificates-update.adoc[Updating OpenShift cluster certificates]
+
//==================== BACKING UP AND RESTORING ===============
//** xref:admin:backup-restore/overview.adoc[]
** Backing up and restoring
** xref:admin:backup-restore/overview.adoc[Backing up and restoring]
*** Central components
**** xref:admin:backup-restore/control-plane-components-backup-restore.adoc[Manual backing up and restoring central components]
**** xref:admin:backup-restore/backup-schedule-cluster-mgmt.adoc[Setting up the central components backup schedule and retention time]
Expand Down Expand Up @@ -71,10 +71,10 @@
// Підключення до бази даних в OpenShift
//** xref:admin:connection-database-openshift.adoc[]
+
// ============= PLATFORM ADMIN STUDY =====================
** Technical platform administrator crash course
*** xref:admin:admin-study/admin-profile.adoc[Technical platform administrator: duties and responsibilities]
+
// ============ EXT SYSTEMS INTERACTION ====================
** Integrating with external systems
*** xref:platform:registry-develop:bp-modeling/bp/rest-connector.adoc#create-service-entry[Integrating with external services using REST connector: Creating a service entry and authorization secret]
+
// ============= PLATFORM ADMIN STUDY =====================
** Technical platform administrator crash course
*** xref:admin:admin-study/admin-profile.adoc[Technical platform administrator: duties and responsibilities]
2 changes: 1 addition & 1 deletion docs/en/modules/release-notes/pages/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This section contains pages describing the development of new system capabilitie

== Section overview

* [*] xref:release-notes:release-notes.adoc[What's new] -- This page presents new release features with a brief description of the functionality. From here, you can navigate to pages with detailed instructions.
* [*] xref:release-notes:whats-new.adoc[What's new] -- This page presents new release features with a brief description of the functionality. From here, you can navigate to pages with detailed instructions.

* [*] xref:release-notes:release-notes.adoc[Release notes] -- This page provides a list of release features tied to the Installer version. The page includes descriptions of new and extended features and a list of fixed defects and flaws, design solutions, and other implementations.

Expand Down
24 changes: 23 additions & 1 deletion docs/ua/modules/admin/pages/admin-overview.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,23 @@
= Адміністраторам платформи
:sectlinks:
= Адміністраторам Платформи

Розділ _Адміністраторам Платформи_ надає докладні інструкції для технічних адміністраторів Платформи, що покриває усі аспекти їх діяльності, від встановлення до інтеграції із зовнішніми системами.

Тут ви знайдете покрокові інструкції зі встановлення та налаштування, вимоги до OKD кластерів, а також деталі розгортання Платформи на цільових середовищах. Розділ також розглядає управління Платформою та реєстрами через адміністративну панель Control Plane, керування ресурсами реєстру, масштабування, конфігурацію цифрових підписів та сертифікатів, налаштування DNS, технічне обслуговування підсистем логування, моніторингу подій, а також роботу із розподіленою файловою системою.

Для тих, хто хоче більш детально ознайомитися із роллю технічного адміністратора Платформи, пропонується детальна посадова інструкція зі стеком технологій, обов'язків та вимог до адміністратора. Окремо описані деякі налаштування інтеграції із зовнішніми системами, що підкреслює важливість забезпечення сумісності та гнучкості нашої Платформи.
Цей розділ -- незамінний ресурс для технічних спеціалістів, які хочуть повністю розуміти та ефективно управляти нашою Платформою.
== Огляд секції
* xref:admin:installation/overview.adoc[Встановлення та налаштування]
* xref:admin:registry-management/overview.adoc[Керування Платформою та реєстрами в Control Plane]
* xref:admin:migrate-registry.adoc[Міграція реєстрів]
* xref:admin:update/overview.adoc[Оновлення]
* xref:admin:backup-restore/overview.adoc[Резервне копіювання та відновлення]
* xref:admin:scaling/overview.adoc[Масштабування]
* xref:admin:logging/elastic-search.adoc[Технічне обслуговування підсистеми логування (EFK)]
* xref:admin:file-system/ceph-space.adoc[Керування розподіленою файловою системою]
* xref:platform:registry-develop:bp-modeling/bp/rest-connector.adoc#create-service-entry[Інтеграція із зовнішніми системами]
* xref:admin:admin-study/admin-profile.adoc[Посадова інструкція для технічного адміністратора Платформи]
2 changes: 1 addition & 1 deletion docs/ua/modules/admin/pages/admin-study/admin-profile.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
:sectlinks:
:partnums:

= Посадова інструкція для технічного адміністратора платформи
= Посадова інструкція для технічного адміністратора Платформи

== Обов'язки та вимоги до технічного адміністратора платформи

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:note-caption: ПРИМІТКА

= Керування платформою та реєстрами в Control Plane
= Керування Платформою та реєстрами в Control Plane

Цей розділ надає деталізовані статті для адміністраторів Платформи та реєстру щодо користування адміністративною панеллю *Control Plane*.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= Структура конфігурації Реєстру
= Структура конфігурації реєстру

include::common/description.adoc[]

Expand Down

0 comments on commit 3f7035b

Please sign in to comment.