diff --git a/.github/workflows/pre-checks.yml b/.github/workflows/pre-checks.yml new file mode 100644 index 0000000..aa798e9 --- /dev/null +++ b/.github/workflows/pre-checks.yml @@ -0,0 +1,25 @@ +# This workflow will install Python dependencies, run tests and lint with a single version of Python +# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions + +name: Manual Pre Checks + +on: + push: + branches: + - "*" + pull_request: + branches: + - main + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +jobs: + linkcheck: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: link-check + run: | + pip install -r requirements.txt + make linkcheck + diff --git a/.readthedocs.yaml b/.readthedocs.yaml index a2804b2..680eb03 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,12 +5,27 @@ build: os: ubuntu-22.04 tools: python: "3.11" + jobs: + pre_build: + - make linkcheck sphinx: configuration: conf.py + fail_on_warning: true formats: all python: install: - - requirements: requirements.txt \ No newline at end of file + - requirements: requirements.txt + +search: + ignore: + # Custom files to ignore + - genindex.html + + # Defaults + - search.html + - search/index.html + - 404.html + - 404/index.html' diff --git a/Makefile b/Makefile index d4bb2cb..5128596 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,9 @@ # Minimal makefile for Sphinx documentation # -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build SOURCEDIR = . BUILDDIR = _build diff --git a/changelog/amc_log.rst b/changelog/amc_log.rst new file mode 100644 index 0000000..3389203 --- /dev/null +++ b/changelog/amc_log.rst @@ -0,0 +1,70 @@ +Management Center v3 +==================== + +This chapter contains all the changes of the ASGARD Management Center. + +Management Center 3.0.12 +------------------------ + +.. list-table:: + :header-rows: 1 + + * - Release Date + * - Thu, 28 Mar 2024 11:46:00 +0200 + +.. list-table:: + :header-rows: 1 + :widths: 15, 85 + + * - Type + - Description + * - Bugfix + - Improved performance of the asset table and the task statistics + * - Bugfix + - Fixed non-working API key generation for read-only users + * - Bugfix + - Fixed non-working CSR generation for HTTPS TLS certificate + * - Bugfix + - Removed some major upgrade leftovers from the diagnostics pack + +Management Center 3.0.11 +------------------------ + +.. list-table:: + :header-rows: 1 + + * - Release Date + * - Wed, 28 Feb 2024 09:19:00 +0200 + +.. list-table:: + :header-rows: 1 + :widths: 15, 85 + + * - Type + - Description + * - Bugfix + - Fixed non-working diagnostics pack generation on some Management Centers + +Management Center 3.0.10 +------------------------ + +.. list-table:: + :header-rows: 1 + + * - Release Date + * - Tue, 20 Feb 2024 13:01:00 +0200 + +.. list-table:: + :header-rows: 1 + :widths: 15, 85 + + * - Type + - Description + * - Operating System Upgrade + - Upgraded operating system from Debian 10 to Debian 12 + * - Switched update server + - Changed update server from update3.nextron-systems.com to update-301.nextron-systems.com. Please adjust your firewall to allow connections to the new server. + * - Time service transition + - Switched from ntp to timesyncd for time synchronization. + * - UI Enhancements + - A fresh, improved look and feel that makes the UI more intuitive and easier to use. \ No newline at end of file diff --git a/changelog/index.rst b/changelog/index.rst index e2746ba..6cc1ba1 100644 --- a/changelog/index.rst +++ b/changelog/index.rst @@ -5,9 +5,9 @@ Changelog This chapter contains a list of all changes. Those changes are only related to the Management -Center version 3. +Center version 3 and its components. .. toctree:: :caption: Contents - log \ No newline at end of file + amc_log \ No newline at end of file diff --git a/changelog/log.rst b/changelog/log.rst deleted file mode 100644 index 257e5b5..0000000 --- a/changelog/log.rst +++ /dev/null @@ -1,22 +0,0 @@ -Management Center v3 -==================== - -This chapter contains all the changes of the ASGARD Management Center. - -Management Center 3.x ---------------------- - -.. list-table:: - :header-rows: 1 - - * - Release Date - * - Tue, 2 Nov 2023 12:35:00 +0100 - -.. list-table:: - :header-rows: 1 - :widths: 15, 85 - - * - Type - - Description - * - Stable Release - - diff --git a/images/setup_nextronInstaller-connectivity.png b/images/setup_nextronInstaller-connectivity.png new file mode 100644 index 0000000..4de505f Binary files /dev/null and b/images/setup_nextronInstaller-connectivity.png differ diff --git a/images/setup_nextronInstaller-diagnostics.png b/images/setup_nextronInstaller-diagnostics.png new file mode 100644 index 0000000..76e2a10 Binary files /dev/null and b/images/setup_nextronInstaller-diagnostics.png differ diff --git a/images/setup_nextronInstaller-finished.png b/images/setup_nextronInstaller-finished.png new file mode 100644 index 0000000..3da95b4 Binary files /dev/null and b/images/setup_nextronInstaller-finished.png differ diff --git a/images/setup_nextronInstaller-fqdn.png b/images/setup_nextronInstaller-fqdn.png new file mode 100644 index 0000000..3269f12 Binary files /dev/null and b/images/setup_nextronInstaller-fqdn.png differ diff --git a/images/setup_nextronInstaller-installation.png b/images/setup_nextronInstaller-installation.png new file mode 100644 index 0000000..7a21c3a Binary files /dev/null and b/images/setup_nextronInstaller-installation.png differ diff --git a/images/setup_nextronInstaller-landing.png b/images/setup_nextronInstaller-landing.png new file mode 100644 index 0000000..08998f3 Binary files /dev/null and b/images/setup_nextronInstaller-landing.png differ diff --git a/images/setup_nextronInstaller-license-review.png b/images/setup_nextronInstaller-license-review.png new file mode 100644 index 0000000..a2dfb4b Binary files /dev/null and b/images/setup_nextronInstaller-license-review.png differ diff --git a/images/setup_nextronInstaller-license.png b/images/setup_nextronInstaller-license.png new file mode 100644 index 0000000..e2df22c Binary files /dev/null and b/images/setup_nextronInstaller-license.png differ diff --git a/images/setup_nextronInstaller-password.png b/images/setup_nextronInstaller-password.png new file mode 100644 index 0000000..36b5222 Binary files /dev/null and b/images/setup_nextronInstaller-password.png differ diff --git a/images/setup_nextronInstaller-product.png b/images/setup_nextronInstaller-product.png new file mode 100644 index 0000000..45832c0 Binary files /dev/null and b/images/setup_nextronInstaller-product.png differ diff --git a/images/setup_nextronInstaller-progress.png b/images/setup_nextronInstaller-progress.png new file mode 100644 index 0000000..483b8b1 Binary files /dev/null and b/images/setup_nextronInstaller-progress.png differ diff --git a/images/setup_nextronInstaller-settings.png b/images/setup_nextronInstaller-settings.png new file mode 100644 index 0000000..c141455 Binary files /dev/null and b/images/setup_nextronInstaller-settings.png differ diff --git a/images/setup_nextronInstaller.png b/images/setup_nextronInstaller.png index fb9a5e8..13eebb7 100644 Binary files a/images/setup_nextronInstaller.png and b/images/setup_nextronInstaller.png differ diff --git a/requirements/agent.rst b/requirements/agent.rst index 55e38b7..5623489 100644 --- a/requirements/agent.rst +++ b/requirements/agent.rst @@ -25,5 +25,5 @@ environment, which you can find in our separate `THOR Manual `_. Supported operating systems are the ones -`supported by THOR `__. +`supported by THOR `__. Not supported are the operating systems with limited or special THOR support. \ No newline at end of file diff --git a/requirements/network.rst b/requirements/network.rst index 9a7f2a3..4d12cb3 100644 --- a/requirements/network.rst +++ b/requirements/network.rst @@ -83,9 +83,7 @@ following remote systems via HTTPS on port 443/tcp: * - Product - Remote Systems * - ASGARD packages - - update-301.nextron-systems.com [2]_ - * - ASGARD packages - - update3.nextron-systems.com [2]_ + - update-301.nextron-systems.com * - THOR updates - update1.nextron-systems.com * - THOR updates @@ -163,9 +161,9 @@ ASGARD needs to be able to resolve internal and external IP addresses. Internet Access during Installation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The Management Center installer requires Internet access during the +The Nextron Universal Installer requires Internet access during the setup. The installation process will fail if required packages cannot be -loaded from https://update3.nextron-systems.com [2]_ +loaded from https://update-301.nextron-systems.com SSL/TLS Interception ~~~~~~~~~~~~~~~~~~~~ @@ -192,7 +190,4 @@ their communication relationships. .. rubric:: Footnotes .. [1] You can configure any port and protocol combination for this, - e.g. 6514/tcp -.. [2] If you are upgrading from Management Center version 2 to version 3, - you need both update servers reachable from your Management Center. If - you installed version 3 directly, you only need https://update-301.nextron-systems.com \ No newline at end of file + e.g. 6514/tcp \ No newline at end of file diff --git a/setup/components.rst b/setup/components.rst index c0c6b53..e3f076e 100644 --- a/setup/components.rst +++ b/setup/components.rst @@ -3,38 +3,139 @@ Install the ASGARD Management Center Service -------------------------------------------- -Use SSH to connect to the appliance using the user ``nextron`` and the password -you specified during the installation. Now you can run the following command: +After the ISO installer is finished with the setup, +you will be greeted at the login prompt with the following +message: -.. code-block:: console +.. figure:: ../images/setup_nextronInstaller.png + :alt: Login prompt ASGARD Server - nextron@asgard:~$ sudo nextronInstaller -asgard +Follow the instructions and navigate to the webpage +displayed on your terminal. You will most likely get +a browser warning when you connect the first time to +the page. This is due to the page using a self signed +certificate, since it will only be used to install the +ASGARD Management Center. You can safely ignore this +warning and proceed to the page. -.. caution:: - Upper case "i" in the middle. +You will be greeted with a small introduction as to what +the Nextron Universal Installer is and what it does. After +you click ``Next``, you will be presented with the landing +page of the Nextron Universal Installer. -This will install the ASGARD Management Center on top of the base operating -system from the ISO. +.. figure:: ../images/setup_nextronInstaller-landing.png + :alt: landing page of the Universal Installer -.. figure:: ../images/setup_nextronInstaller.png - :alt: running the nextronInstaller - -After the installation is completed, type the following command to see -if the service is running: - -.. code-block:: console - :emphasize-lines: 5 - - nextron@asgard:~$ sudo systemctl status asgard-management-center.service - [sudo] password for nextron: - ● asgard-management-center.service - ASGARD Management Center - Loaded: loaded (/lib/systemd/system/asgard-management-center.service; enabled; preset: enabled) - Active: active (running) since Tue 2024-01-16 13:45:15 CET; 1min 38s ago - Process: 898 ExecStartPre=/usr/share/asgard-management-center/scripts/exec_start_pre.sh (code=exited, status=0/SUCCESS) - Main PID: 927 (exec_start.sh) - Tasks: 10 (limit: 4601) - Memory: 186.0M - CPU: 2.043s - -The installation is now completed, you are ready to log into the web UI -of your Management Center. +Enter the Installation Code from the terminal and click +``Next``. The Installer will now prompt you to upload your +license for the product you intend to install. + +.. figure:: ../images/setup_nextronInstaller-license.png + :alt: License Prompt of the Universal Installer + +After you have uploaded your license, the Installer will +display informations about the license you uploaded. Verify +the information and click ``Next`` to proceed. + +.. figure:: ../images/setup_nextronInstaller-license-review.png + :alt: License Review of the Universal Installer + +The next step is a connectiviy check. The Installer will +try to connect to our update server in order to download all +the necessary packages once the installation starts. Make sure +you can reach the update servers (see :ref:`requirements/network:internet access during installation`). + +Click ``Next`` to proceed. + +.. figure:: ../images/setup_nextronInstaller-connectivity.png + :alt: Connectivity Check of the Universal Installer + +After the connectivity check is completed, the Installer +will prompt you to verify the FQDN which you configured during +the installation of the base system. If the FQDN shown is correct, +type it into the text field for verification and click ``Next``. + +If the displayed FQDN is not correct, you can change it by +clicking on the ``View FQDN Change Instructions`` button. +This will open a dialog with instructions on how to change +the FQDN of your server. Once you have changed the FQDN, +you can continue with the installation. + +.. figure:: ../images/setup_nextronInstaller-fqdn.png + :alt: FQDN Verification of the Universal Installer + +.. danger:: + The FQDN verification is a crucial step in the installation + process. If the FQDN is not correct, you might encounter issues + when using our product. Make sure to verify the FQDN before + proceeding. + +After the FQDN verification is completed, the Installer will +show you the available products you can install with the +license you uploaded. Select the product you want to install +and click ``Next``. + +.. figure:: ../images/setup_nextronInstaller-product.png + :alt: Product Selection of the Universal Installer + +.. note:: + There might be different services you can choose for + installation, depending on the license you uploaded. + +You will now be prompted to configure a password for the +admin user of the ASGARD Management Center. Enter a password +and click ``Submit Configuration``. You can now continue to the +next step by clicking ``Next``. + +.. figure:: ../images/setup_nextronInstaller-password.png + :alt: Password Configuration of the Universal Installer + +You will now be prompted to start the installation by clicking +the ``Start Installation`` button. The Installer will now +download the necessary packages and install the ASGARD Management +Center. This process can take a few minutes, depending on your +internet connection. + +.. figure:: ../images/setup_nextronInstaller-installation.png + :alt: Installation of the Universal Installer + +After the installation started, you will see console output +of the installation process and a progress bar below it. + +.. figure:: ../images/setup_nextronInstaller-progress.png + :alt: Installation Progress of the Universal Installer + +Once the installation is finished, click ``Next``. You will +now be prompted to reboot the system. Click the ``Restart System`` +button to reboot the system. + +.. figure:: ../images/setup_nextronInstaller-finished.png + :alt: Installation Finished of the Universal Installer + +Proxy and NTP Settings +~~~~~~~~~~~~~~~~~~~~~~ + +If you need to configure a proxy or change the NTP settings +of your system, you can do so by clicking on the ``Settings`` +button in the left menu of the Nextron Universal Installer. + +.. figure:: ../images/setup_nextronInstaller-settings.png + :alt: Settings of the Universal Installer + +If you configured a proxy during the ISO installation, those +settings will be carried over into the Universal Installer. +The settings will also be carried over into your ASGARD +Management Center. The same goes for NTP. + +Diagnostic Pack +~~~~~~~~~~~~~~~ + +In case of errors or problems during the installation, you can +download a diagnostic pack by navigating to the ``Diagnostics`` +tab in the left menu of the Nextron Universal Installer. Click +on the ``Download Diagnostic Pack`` button to download the +diagnostic pack. You can then send the diagnostic pack to our +support team for further analysis. + +.. figure:: ../images/setup_nextronInstaller-diagnostics.png + :alt: Diagnostics of the Universal Installer \ No newline at end of file