nautobot 2.0.4__py3-none-any.whl → 2.1.0b1__py3-none-any.whl

nautobot/docs/user-guide/administration/installation/install_system.md

@@ -1,493 +0,0 @@
-# Installing Nautobot System Dependencies
-
-The documentation assumes that you are running one of the following:
-
-- Ubuntu 20.04+
-- Debian 11+
-- RHEL/CentOS 8.2+
-    - Also includes other derivatives of RHEL such as RockyLinux or AlmaLinux
-
-## Install System Packages
-
-Install the prerequisite system libraries and utilities.
-
-This will install:
-
-- Git
-- Python 3
-- Pip
-- Redis server and client
-- Node.JS and NPM
-
-=== "Ubuntu/Debian"
-
-    ```bash
-    sudo apt update -y
-    sudo apt install -y ca-certificates curl gnupg # Pre-requisites for adding the NodeSource Node.js repository
-
-    # NodeSource Node.js Repository Setup
-    sudo mkdir -p /etc/apt/keyrings  # Create the keyring directory if it doesn't exist
-    curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg  # Add the Node.js signing key
-    NODE_MAJOR=18  # Nautobot requires Node.js 18, the latest LTS release
-    echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list  # Add the Node.js repository
-    
-    sudo apt update -y
-    sudo apt install -y git python3 python3-pip python3-venv python3-dev redis-server nodejs
-    ```
-
-=== "RHEL8 + Derivatives"
-
-    ```bash
-    sudo dnf check-update
-    sudo dnf install -y git python38 python38-devel python38-pip redis
-    sudo dnf module reset -y nodejs # Reset the nodejs modules to ensure we get the desired version
-    sudo dnf module enable -y nodejs:18 # Enable the Node.js 18.x module
-    sudo dnf module install -y nodejs:18/common # Install Node.js 18.x
-    ```
-
-## Database Setup
-
-In this step you'll set up your database server, create a database and database user for use by Nautobot, and verify your connection to the database.
-
-You must select either MySQL (MariaDB is **not** supported) or PostgreSQL. PostgreSQL is used by default with Nautobot, so if you just want to get started or don't have a preference, please stick with PostgreSQL.
-
-Please follow the steps for your selected database backend below.
-
-=== "Ubuntu/Debian PostgreSQL"
-
-    ### Install PostgreSQL
-
-    This will install the PostgreSQL database server and client.
-
-    ```no-highlight
-    sudo apt install -y postgresql
-    ```
-
-    ### Create a PostgreSQL Database
-
-    At a minimum, we need to create a database for Nautobot and assign it a username and password for authentication. This
-    is done with the following commands.
-
-    !!! danger
-        **Do not use the password from the example.** Choose a strong, random password to ensure secure database authentication for your Nautobot installation.
-
-    ```no-highlight
-    sudo -u postgres psql
-    ```
-
-    Example output:
-
-    ```no-highlight
-    psql (12.5 (Ubuntu 12.5-0ubuntu0.20.04.1))
-    Type "help" for help.
-
-    postgres=# CREATE DATABASE nautobot;
-    CREATE DATABASE
-    postgres=# CREATE USER nautobot WITH PASSWORD 'insecure_password';
-    CREATE ROLE
-    postgres=# GRANT ALL PRIVILEGES ON DATABASE nautobot TO nautobot;
-    GRANT
-    postgres=# GRANT CREATE ON SCHEMA public TO nautobot;
-    GRANT
-    postgres=# \q
-    ```
-
-    #### Verify PostgreSQL Service Status
-
-    You can verify that authentication works issuing the following command and providing the configured password. (Replace `localhost` with your database server if using a remote database.)
-
-    If successful, you will enter a `nautobot` prompt. Type `\conninfo` to confirm your connection, or type `\q` to exit.
-
-    ```no-highlight
-    psql --username nautobot --password --host localhost nautobot
-    ```
-
-    Example output:
-
-    ```no-highlight
-    Password for user nautobot:
-    psql (12.5 (Ubuntu 12.5-0ubuntu0.20.04.1))
-    SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off)
-    Type "help" for help.
-
-    nautobot=> \conninfo
-    You are connected to database "nautobot" as user "nautobot" on host "localhost" (address "127.0.0.1") at port "5432".
-    SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off)
-    nautobot=> \q
-    ```
-
-=== "Ubuntu/Debian MySQL"
-
-    ### Install MySQL
-
-    This will install the MySQL database server and client. Additionally, MySQL requires that the MySQL development libraries are installed so that we may compile the Python `mysqlclient` library during the Nautobot installation steps.
-
-    ```no-highlight
-    sudo apt install -y libmysqlclient-dev mysql-server
-    ```
-
-    !!! note
-        In the Nautobot Docker image `libmariadb-dev` is installed due to licensing challenges with `libmysqlclient-dev`. 
-
-    ### Create a MySQL Database
-
-    At a minimum, we need to create a database for Nautobot and assign it a username and password for authentication. This is done with the following commands.
-
-    !!! note
-        Replace `localhost` below with your database server if using a remote database.
-
-    !!! danger
-        **Do not use the password from the example.** Choose a strong, random password to ensure secure database authentication for your Nautobot installation.
-
-    ```no-highlight
-    sudo -u root mysql
-    ```
-
-    Example output:
-
-    ```no-highlight
-    Welcome to the MySQL monitor.  Commands end with ; or \g.
-    Your MySQL connection id is 11
-    Server version: 8.0.25-0ubuntu0.20.04.1 (Ubuntu)
-
-    Copyright (c) 2000, 2021, Oracle and/or its affiliates.
-
-    Oracle is a registered trademark of Oracle Corporation and/or its
-    affiliates. Other names may be trademarks of their respective
-    owners.
-
-    Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
-
-    mysql> CREATE DATABASE nautobot;
-    Query OK, 1 row affected (0.00 sec)
-
-    mysql> CREATE USER 'nautobot'@'localhost' IDENTIFIED BY 'insecure_password';
-    Query OK, 0 rows affected (0.01 sec)
-
-    mysql> GRANT ALL ON nautobot.* TO 'nautobot'@'localhost';
-    Query OK, 0 rows affected (0.00 sec)
-
-    mysql> \q
-    Bye
-    ```
-
-    #### Verify MySQL Service Status
-
-    You can verify that authentication works issuing the following command and providing the configured password.
-
-    If successful, you will enter a `mysql>` prompt. Type `status` to confirm your connection, or type `\q` to exit.
-
-    !!! note
-        Replace `localhost` below with your database server if using a remote database.
-
-    ```no-highlight
-    mysql --user nautobot --password --host localhost nautobot
-    ```
-
-    Example output:
-
-    ```no-highlight
-    Enter password:
-    Welcome to the MySQL monitor.  Commands end with ; or \g.
-    Your MySQL connection id is 13
-    Server version: 8.0.25-0ubuntu0.20.04.1 (Ubuntu)
-
-    Copyright (c) 2000, 2021, Oracle and/or its affiliates.
-
-    Oracle is a registered trademark of Oracle Corporation and/or its
-    affiliates. Other names may be trademarks of their respective
-    owners.
-
-    Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
-
-    mysql> status
-    --------------
-    mysql  Ver 8.0.25-0ubuntu0.20.04.1 for Linux on x86_64 ((Ubuntu))
-
-    Connection id:          13
-    Current database:       nautobot
-    Current user:           nautobot@localhost
-    SSL:                    Not in use
-    Current pager:          stdout
-    Using outfile:          ''
-    Using delimiter:        ;
-    Server version:         8.0.25-0ubuntu0.20.04.1 (Ubuntu)
-    Protocol version:       10
-    Connection:             Localhost via UNIX socket
-    Server characterset:    utf8mb4
-    Db     characterset:    utf8mb4
-    Client characterset:    utf8mb4
-    Conn.  characterset:    utf8mb4
-    UNIX socket:            /var/run/mysqld/mysqld.sock
-    Binary data as:         Hexadecimal
-    Uptime:                 26 min 31 sec
-
-    Threads: 2  Questions: 29  Slow queries: 0  Opens: 193  Flush tables: 3  Open tables: 112  Queries per second avg: 0.018
-    --------------
-
-    mysql> \q
-    Bye
-    ```
-
-=== "RHEL8 PostgreSQL"
-
-    ### Install PostgreSQL
-
-    This will install the PostgreSQL database server and client.
-
-    ```no-highlight
-    sudo dnf install -y postgresql-server
-    ```
-
-    ### Initialize PostgreSQL
-
-    CentOS/RHEL requires a manual step to generate the initial configurations required by PostgreSQL.
-
-    ```no-highlight
-    sudo postgresql-setup --initdb
-    ```
-
-    ### Configure Authentication
-
-    CentOS/RHEL configures PostgreSQL to use [`ident`](https://www.postgresql.org/docs/current/auth-ident.html) host-based authentication by default. Because Nautobot will need to authenticate using a username and password, we must update `pg_hba.conf` to support [`md5` password](https://www.postgresql.org/docs/current/auth-password.html) authentication.
-
-    As root, edit `/var/lib/pgsql/data/pg_hba.conf` and change `ident` to `md5` for the lines below.
-
-    Before:
-
-    ```no-highlight
-    # IPv4 local connections:
-    host    all             all             127.0.0.1/32            ident
-    # IPv6 local connections:
-    host    all             all             ::1/128                 ident
-    ```
-
-    After:
-
-    ```no-highlight
-    # IPv4 local connections:
-    host    all             all             127.0.0.1/32            md5
-    # IPv6 local connections:
-    host    all             all             ::1/128                 md5
-    ```
-
-    #### Start PostgreSQL
-
-    Start the service and enable it to run at system startup:
-
-    ```no-highlight
-    sudo systemctl enable --now postgresql
-    ```
-
-    #### Create a PostgreSQL Database
-
-    At a minimum, we need to create a database for Nautobot and assign it a username and password for authentication. This
-    is done with the following commands.
-
-    !!! danger
-        **Do not use the password from the example.** Choose a strong, random password to ensure secure database authentication for your Nautobot installation.
-
-    ```no-highlight
-    sudo -u postgres psql
-    ```
-
-    Example output:
-
-    ```no-highlight
-    psql (10.15)
-    Type "help" for help.
-    ```
-
-    ```no-highlight
-    postgres=# CREATE DATABASE nautobot;
-    CREATE DATABASE
-    postgres=# CREATE USER nautobot WITH PASSWORD 'insecure_password';
-    CREATE ROLE
-    postgres=# GRANT ALL PRIVILEGES ON DATABASE nautobot TO nautobot;
-    GRANT
-    postgres=# \q
-    ```
-
-    ### Verify PostgreSQL Service Status
-
-    You can verify that authentication works issuing the following command and providing the configured password. (Replace `localhost` with your database server if using a remote database.)
-
-    If successful, you will enter a `nautobot` prompt. Type `\conninfo` to confirm your connection, or type `\q` to exit.
-
-    ```no-highlight
-    psql --username nautobot --password --host localhost nautobot
-    ```
-
-    Example output:
-
-    ```no-highlight
-    Password for user nautobot:
-    psql (10.15)
-    Type "help" for help.
-
-    nautobot=> \conninfo
-    You are connected to database "nautobot" as user "nautobot" on host "localhost" (address "127.0.0.1") at port "5432".
-    nautobot=> \q
-    ```
-
-=== "RHEL8 MySQL"
-
-    ### Install MySQL
-
-    This will install the MySQL database server and client. Additionally, MySQL requires that `gcc` and the MySQL development libraries are installed so that we may compile the Python `mysqlclient` library during the Nautobot installation steps.
-
-    ```no-highlight
-    sudo dnf install -y gcc mysql-server mysql-devel
-    ```
-
-    ### Start MySQL
-
-    Start the service and enable it to run at system startup:
-
-    ```no-highlight
-    sudo systemctl enable --now mysql
-    ```
-
-    ### Create a MySQL Database
-
-    At a minimum, we need to create a database for Nautobot and assign it a username and password for authentication. This is done with the following commands.
-
-    !!! note
-        Replace `localhost` below with your database server if using a remote database.
-
-    !!! danger
-        **Do not use the password from the example.** Choose a strong, random password to ensure secure database authentication for your Nautobot installation.
-
-    ```no-highlight
-    sudo -u root mysql
-    ```
-
-    Example output:
-
-    ```no-highlight
-    Welcome to the MySQL monitor.  Commands end with ; or \g.
-    Your MySQL connection id is 8
-    Server version: 8.0.21 Source distribution
-
-    Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
-
-    Oracle is a registered trademark of Oracle Corporation and/or its
-    affiliates. Other names may be trademarks of their respective
-    owners.
-
-    Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
-
-    mysql> CREATE DATABASE nautobot;
-    Query OK, 1 row affected (0.00 sec)
-
-    mysql> CREATE USER 'nautobot'@'localhost' IDENTIFIED BY 'insecure_password';
-    Query OK, 0 rows affected (0.00 sec)
-
-    mysql> GRANT ALL ON nautobot.* TO 'nautobot'@'localhost';
-    Query OK, 0 rows affected (0.00 sec)
-
-    mysql> \q
-    Bye
-    ```
-
-    ### Verify MySQL Service Status
-
-    You can verify that authentication works issuing the following command and providing the configured password.
-
-    If successful, you will enter a `mysql>` prompt. Type `status` to confirm your connection, or type `\q` to exit.
-
-    !!! note
-        Replace `localhost` below with your database server if using a remote database.
-
-    ```no-highlight
-    mysql --user nautobot --password --host localhost nautobot
-    ```
-
-    Example output:
-
-    ```no-highlight
-    Enter password:
-    Welcome to the MySQL monitor.  Commands end with ; or \g.
-    Your MySQL connection id is 10
-    Server version: 8.0.21 Source distribution
-
-    Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
-
-    Oracle is a registered trademark of Oracle Corporation and/or its
-    affiliates. Other names may be trademarks of their respective
-    owners.
-
-    Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
-
-    mysql> status
-    --------------
-    mysql  Ver 8.0.21 for Linux on x86_64 (Source distribution)
-
-    Connection id:          10
-    Current database:       nautobot
-    Current user:           nautobot@localhost
-    SSL:                    Not in use
-    Current pager:          stdout
-    Using outfile:          ''
-    Using delimiter:        ;
-    Server version:         8.0.21 Source distribution
-    Protocol version:       10
-    Connection:             Localhost via UNIX socket
-    Server characterset:    utf8mb4
-    Db     characterset:    utf8mb4
-    Client characterset:    utf8mb4
-    Conn.  characterset:    utf8mb4
-    UNIX socket:            /var/lib/mysql/mysql.sock
-    Binary data as:         Hexadecimal
-    Uptime:                 4 min 12 sec
-
-    Threads: 2  Questions: 12  Slow queries: 0  Opens: 151  Flush tables: 3  Open tables: 69  Queries per second avg: 0.047
-    --------------
-
-    mysql> \q
-    Bye
-    ```
-
-## Redis Setup
-
-=== "Ubuntu/Debian"
-
-    Since Redis was already installed, let's just verify that it's working using `redis-cli`:
-
-    ```no-highlight
-    redis-cli ping
-    ```
-
-    Example output:
-
-    ```no-highlight
-    PONG
-    ```
-
-=== "RHEL8"
-
-    ### Start Redis
-
-    Start the service and enable it to run at system startup:
-
-    ```no-highlight
-    sudo systemctl enable --now redis
-    ```
-
-    ### Verify Redis Service Status
-
-    Use the `redis-cli` utility to ensure the Redis service is functional:
-
-    ```no-highlight
-    redis-cli ping
-    ```
-
-    Example output:
-
-    ```no-highlight
-    PONG
-    ```
-
-## Deploy Nautobot
-
-Now that Nautobot dependencies are installed and configured, you're ready to [Install Nautobot](nautobot.md)!