Skip to content

Commit

Permalink
Merge branch 'main' into docs-19.03.01
Browse files Browse the repository at this point in the history
  • Loading branch information
Nadia-JSch authored Oct 14, 2024
2 parents e06390e + 5ed9607 commit 7f2db47
Show file tree
Hide file tree
Showing 72 changed files with 1,026 additions and 727 deletions.
25 changes: 19 additions & 6 deletions docs/administration/advanced-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,30 @@ title: "Advanced Routing"
sidebar_position: 2
---

You can add complex or advanced routing for your Device42 appliance or delete it using the console menu.
You can add complex or advanced routing for your Device42 appliance or delete it using the virtual machine (VM) console menu.

1. To configure advanced routing, choose option **15** from the **Device42 Setup/Troubleshooting Menu**. Log in to the console of the Device42 VM to access this menu:
To add a new route, follow these steps:

![advanced-routing-option](/assets/images/advanced-routing/console-advanced-routing-option.png)
1. Log in to the Device42 VM console.
2. Choose **(u) Network, Connectivity and Utilities**.

2. To add a new route, enter option **a**. Print the routing table with option **b**.
![Network options](/assets/images/advanced-routing/1-network.png)

3. Select **(r) Routing**.

![Routing options](/assets/images/advanced-routing/2-routing.png)

4. Select **(a) Add a new Route** from the **Routing Configuration Main Menu**.

![Advanced routing options](/assets/images/advanced-routing/console-routing-submenu.png)
![Add route option](/assets/images/advanced-routing/3-route-options.png)

5. Fill in the new route details and click **Add Route**. Use the `Tab` key to navigate to the next field.

![Add route details](/assets/images/advanced-routing/4-route-details.png)

3. After configuring the new route, enter option **d** to apply changes. The Device42 VM must be manually rebooted to clear deleted routes.
6. After configuring the new route, enter option **(p) Apply Routes** from the previous menu to apply the changes.

The Device42 VM must be manually rebooted to clear deleted routes.

:::info
Advanced routing instructions are also available [in video format here](how-to-videos/add-a-new-route-to-device42.md).
Expand Down
114 changes: 114 additions & 0 deletions docs/administration/updating-device42.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
---
title: "Updating Device42"
sidebar_position: 0.5
---

import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'
import vmConsole from '/assets/images/updating-device42/vm-menu-options.png'

Updating to the latest version of Device42 ensures you get the most out of your CMDB and benefit from the newest features, integrations, and security and performance improvements.

## How to Update the Device42 Main Appliance

To update your Main Appliance, follow these steps:

1. Obtain the update file or URL via email.
2. Back up your Device42 data in the Appliance Manager.
3. Upload the update file or enter the update URL in the Appliance Manager.
4. Log in to the Virtual Machine (VM) console.
5. Apply the update from the VM console.
6. Verify the update from the Main Appliance.

:::tip
Watch the quick [How To Update the Device42 Main Appliance](how-to-videos/update-device42-appliance-how-to.md) walkthrough video of the process.
:::

### 1. Obtain the Upgrade File or URL

To update the Main Appliance, you need to download the update file. In some cases, technical support may have emailed you an update URL to use instead of the update file. If you've received an email with an update URL, proceed to the next step: [Back Up Your Data](#back-up-your-data).

- From the Main Appliance, navigate to **Tools > Update** and click the [**Check for latest version** link](https://www.device42.com/update/).

You can visit [https://www.device42.com/update/](https://www.device42.com/update/) directly, but navigating to the link on the **Update Software** page allows you to take note of your current version, which is useful for verifying a successful update later.

<ThemedImage
alt="Update Software page"
sources={{
light: useBaseUrl('/assets/images/updating-device42/update-software-older-version-light.png'),
dark: useBaseUrl('/assets/images/updating-device42/update-software-older-version-dark.png'),
}}
style={{ width: '80%' }}
/>

- Fill in the form on the website and click **Download update**.

![Website form](/assets/images/updating-device42/website-form.png)

- You'll receive an automated email with several links to download the `.zip.enc` file. If your Main Appliance has already been updated to the latest [major](https://semver.org/) version and you're applying a minor or patch-release update, or if your MA's latest update was to a major version, choose the first link (in bold).

If your Main Appliance is one or several releases behind the current major version, choose the second or third link, depending on your version, to first update it to the major version. When you've updated to the latest major version, you may need to perform a second update to the current minor or patch-release version afterward.

![Email with links](/assets/images/updating-device42/email.png)

### 2. Back Up Your Data

Head to the Appliance Manager by entering `http://your-device42-IP-or-FQDN:4242` or `https://your-device42-IP-or-FQDN:4343` into your browser. Optionally, you can take a virtual machine snapshot from your virtualization platform as a backup.

:::note
The default credentials for the Appliance Manager are `d42admin / default`, or for AWS instances, `d42admin / AWS_INSTANCE_ID`. Please ensure you change the `default` password to your own secure credentials.
:::

Navigate to **Backup/Restore > Backup Now** and select the **Main Appliance** checkbox. If you want to include users and settings, select the **Backup Meta Data** option. **Run** the backup.

![Backup settings on the Appliance Manager](/assets/images/updating-device42/backup-appliance.png)

### 3. Upload the Update File

From the Main Appliance, navigate to **Application > Update Software** and **either** browse and upload the [`.zip.enc` file](#obtain-the-update-file-or-url) **or** enter the update URL.

![Upload file or enter URL in the Appliance Manager](/assets/images/updating-device42/upload-file.png)

A green status bar indicates the upload progress.

![Green upload status bar](/assets/images/updating-device42/status-bar.png)

When the file has been uploaded, log in to the VM console.

### 4. Log In to the VM Console

There are two ways to log in to the VM console:

1. Access the VM console through your virtual platform.
2. **Via SSH:**

- Use port 404 on the Device42 IP address.
- If you're using a power appliance, use port 442.
- For AWS deployments, SSH in to the device using `device42` as your username and `AWS-KEYFILE` as your password. For example:

```shell
ssh -i /path/to/your/private-key.pem -p port_number username@hostname
```

### 5. Apply the Update

Select option **a** in the console to apply the update. It usually takes 15 to 30 minutes to apply the update.

<img alt="VM console menu options" src={vmConsole} width="90%"/>

### 6. Verify the Update

Return to the **Update Software** page of the Main Appliance to confirm that the new version has been applied.

<ThemedImage
alt="Update settings page"
sources={{
light: useBaseUrl('/assets/images/updating-device42/settings-update-light.png'),
dark: useBaseUrl('/assets/images/updating-device42/settings-update-dark.png'),
}}
style={{ width: '80%' }}
/>

## Updating the Remote Collectors

As long as your Remote Collectors are connected to a Device42 Main Appliance, any updates will be automatically applied to the Remote Collectors when the Main Appliance is updated.
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,7 @@ Device42 discovery supports the following cloud types, as listed in the dropdown
/>

## Alibaba Cloud Autodiscovery
What does Alibaba Cloud Discovery gather? In addition to standard discovery methods, the discovery monitors network traffic to see all routes during discovery execution for Application Dependency Mapping.

A read-only Alibaba role can be provided, as the discovery does not change the cloud infrastructure during execution. Device42 needs an Alibaba account with the built-in permission set to `ReadOnlyAccess`.
What does Alibaba Cloud Discovery gather? In addition to standard discovery methods, the discovery monitors network traffic to see all routes during discovery execution for Application Dependency Mapping. A read only Alibaba role can be provided as the discovery performs no changes to the cloud infrastructure during execution.

**Alibaba Discovery Items**

Expand Down
138 changes: 0 additions & 138 deletions docs/auto-discovery/d42-ping-sweep.md

This file was deleted.

Loading

0 comments on commit 7f2db47

Please sign in to comment.