From af74dbca4054d0d58fceff0bcea670616c03eade Mon Sep 17 00:00:00 2001 From: sakethanne Date: Tue, 5 Nov 2024 15:00:46 -0800 Subject: [PATCH] docs(opi): moved the docs to a folder and updated file references Signed-off-by: sakethanne --- bom.md => Documentation/bom.md | 0 cables.md => Documentation/cables.md | 0 .../hosting_files_on_webserver.md | 0 .../idrac_os_installation_steps_network.md | 0 .../idrac_os_installation_steps_virtual_media.md | 0 ips.md => Documentation/ips.md | 0 otel.md => Documentation/otel.md | 0 .../physical-testbed.md | 0 .../running-the-tests.md | 0 server-setup.md => Documentation/server-setup.md | 4 ++-- README.md | 14 +++++++------- hardware/README.md | 12 ++++++------ hardware/mgmt/README.md | 8 ++++---- 13 files changed, 19 insertions(+), 19 deletions(-) rename bom.md => Documentation/bom.md (100%) rename cables.md => Documentation/cables.md (100%) rename hosting_files_on_webserver.md => Documentation/hosting_files_on_webserver.md (100%) rename idrac_os_installation_steps_network.md => Documentation/idrac_os_installation_steps_network.md (100%) rename idrac_os_installation_steps_virtual_media.md => Documentation/idrac_os_installation_steps_virtual_media.md (100%) rename ips.md => Documentation/ips.md (100%) rename otel.md => Documentation/otel.md (100%) rename physical-testbed.md => Documentation/physical-testbed.md (100%) rename running-the-tests.md => Documentation/running-the-tests.md (100%) rename server-setup.md => Documentation/server-setup.md (97%) diff --git a/bom.md b/Documentation/bom.md similarity index 100% rename from bom.md rename to Documentation/bom.md diff --git a/cables.md b/Documentation/cables.md similarity index 100% rename from cables.md rename to Documentation/cables.md diff --git a/hosting_files_on_webserver.md b/Documentation/hosting_files_on_webserver.md similarity index 100% rename from hosting_files_on_webserver.md rename to Documentation/hosting_files_on_webserver.md diff --git a/idrac_os_installation_steps_network.md b/Documentation/idrac_os_installation_steps_network.md similarity index 100% rename from idrac_os_installation_steps_network.md rename to Documentation/idrac_os_installation_steps_network.md diff --git a/idrac_os_installation_steps_virtual_media.md b/Documentation/idrac_os_installation_steps_virtual_media.md similarity index 100% rename from idrac_os_installation_steps_virtual_media.md rename to Documentation/idrac_os_installation_steps_virtual_media.md diff --git a/ips.md b/Documentation/ips.md similarity index 100% rename from ips.md rename to Documentation/ips.md diff --git a/otel.md b/Documentation/otel.md similarity index 100% rename from otel.md rename to Documentation/otel.md diff --git a/physical-testbed.md b/Documentation/physical-testbed.md similarity index 100% rename from physical-testbed.md rename to Documentation/physical-testbed.md diff --git a/running-the-tests.md b/Documentation/running-the-tests.md similarity index 100% rename from running-the-tests.md rename to Documentation/running-the-tests.md diff --git a/server-setup.md b/Documentation/server-setup.md similarity index 97% rename from server-setup.md rename to Documentation/server-setup.md index f0f2ddc..20a4a72 100644 --- a/server-setup.md +++ b/Documentation/server-setup.md @@ -10,9 +10,9 @@ ansible-playbook -i inventory site.yml ## Manual -For more details on iDRAC OS Installation using Virtual media see [here](idrac_os_installation_steps_virtual_media.md) +For more details on iDRAC OS Installation using Virtual media see [here](idrac_os_installation_steps_virtual_media.md). -For more details on iDRAC OS Installation using Remote File Share see [here](idrac_os_installation_steps_network.md) +For more details on iDRAC OS Installation using Remote File Share see [here](idrac_os_installation_steps_network.md). * Install Ubuntu[^1] 22.04 x64 on the server. ([ubuntu-22.04.1-live-server-amd64.iso](https://releases.ubuntu.com/22.04/)) * select all default options (unless otherwise noted bellow) diff --git a/README.md b/README.md index 0d38656..72a3e9d 100644 --- a/README.md +++ b/README.md @@ -35,12 +35,12 @@ We manage all passwords in - [Goals and Requirments](goals-and-requirements.md) - Setup - - [Cables/Fibers/transceivers](./cables.md) - - [LAB IPs allocation](./ips.md) and [Inventory](./ansible/inventory) - - [Open Telemetry Observability](./otel.md) - - [Server Software Setup](server-setup.md) - - [Bill of Materials](bom.md) - - [Physical Testbed Setup](physical-testbed.md) + - [Cables/Fibers/transceivers](./Documentation/cables.md) + - [LAB IPs allocation](./Documentation/ips.md) and [Inventory](./ansible/inventory) + - [Open Telemetry Observability](./Documentation/otel.md) + - [Server Software Setup](./Documentation/server-setup.md) + - [Bill of Materials](./Documentation/bom.md) + - [Physical Testbed Setup](./Documentation/physical-testbed.md) - [ToR - Arista DCS-7280TR-48C6-R](./hardware/ToR/README.md) - [TS - Serial Consoles - Avocent ACS8000](./hardware/TS/README.md) - [KVM - KVM Switch - Avocent MPU8032DAC](./hardware/KVM/README.md) @@ -52,7 +52,7 @@ We manage all passwords in - [DH4 - DPU Host 4 - Dell R760](./hardware/dh4/README.md) - [A100G - 100G Switch - Arista DCS-7280CR](./hardware/A100G/README.md) - [TGEN1 - Traffic Generator 1 - Supermicro](./hardware/tgen1/README.md) -- [Running the Test Cases](running-the-tests.md) +- [Running the Test Cases](./Documentation/running-the-tests.md) ## Rack diagram diff --git a/hardware/README.md b/hardware/README.md index 580f9c8..27ff651 100644 --- a/hardware/README.md +++ b/hardware/README.md @@ -1,11 +1,11 @@ # OPI Lab -- [Cables](../cables.md) -- [LAB IPs allocation](../ips.md) and [Inventory](../ansible/inventory) -- [Server Software Setup](../server-setup.md) -- [Bill of Materials](../bom.md) -- [Physical Testbed Setup](../physical-testbed.md) -- [Running the Test Cases](../running-the-tests.md) +- [Cables](../Documentation/cables.md) +- [LAB IPs allocation](../Documentation/ips.md) and [Inventory](../ansible/inventory) +- [Server Software Setup](../Documentation/server-setup.md) +- [Bill of Materials](../Documentation/bom.md) +- [Physical Testbed Setup](../Documentation/physical-testbed.md) +- [Running the Test Cases](../Documentation/running-the-tests.md) - [Goals and Requirments](../goals-and-requirements.md) ## OPI Rack diff --git a/hardware/mgmt/README.md b/hardware/mgmt/README.md index 8b35538..42a72b7 100644 --- a/hardware/mgmt/README.md +++ b/hardware/mgmt/README.md @@ -31,19 +31,19 @@ Follow GitHub [instructions](https://github.com/opiproject/opi-poc/settings/acti ## Ansible -- Run `docker compose up -d semaphore` or `docker-compose up -d semaphore` from [here](../../otel). +- Run `docker compose up -d semaphore` or `docker-compose up -d semaphore` from [here](../../Documentation/otel). - This will start [Ansible Semaphore](https://docs.semui.co). - Access it via ## Portainer -- Run `docker compose up -d portainer` or `docker-compose up -d portainer` from [here](../../otel). +- Run `docker compose up -d portainer` or `docker-compose up -d portainer` from [here](../../Documentation/otel). - This will start [Portainer Community Edition](https://www.portainer.io/). - Access it via ## Monitoring & Telemetry -Run `docker compose up -d` or `docker-compose up -d` from [here](../../otel) +Run `docker compose up -d` or `docker-compose up -d` from [here](../../Documentation/otel) 1. [OTEL Gateway Collector](https://opentelemetry.io/docs/collector/deployment/gateway/) to aggregate telemetry from all DPUs and IPUs. 2. [Prometheus](https://prometheus.io/) Monitoring system & time series database @@ -57,7 +57,7 @@ Acccess it via: ## Paswordless -for all servers, dpu and ipus from [here](../../ips.md) run: +for all servers, dpu and ipus from [here](../../Documentation/ips.md) run: ```bash ssh-copy-id root@172.22.X.X