Skip to content

Commit fa18f58

Browse files
authored
Merge pull request #477 from ritza-co/1146-installation
Proposed Installation section improvements
2 parents c67b83c + 17042e2 commit fa18f58

16 files changed

+452
-273
lines changed

docs/getstarted/installation/how-do-i-install-device42-xenkvm-appliance-if-import-existing-disk-image-option-is-missing.mdx

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,23 @@
11
---
22
title: "Xen or KVM - Import Disk Alternate Install"
3-
sidebar_position: 17
3+
sidebar_position: 9
44
---
55

66
:::info
77
These are **special case** installation instructions for installing the Device42 appliance on Xen- or KVM-based platforms if the **Import existing disk image** option is missing. Otherwise, please refer to the Device42 [guide to Xen and KVM installation](getstarted/installation/installation-xen-or-kvm-using-virt-manager.mdx).
88
:::
99

10+
## Outline of Alternative Installation
11+
12+
1. Download the Device42 image and use bunzip2 to uncompress the image.
13+
2. Create a new virtual machine using the **Network Boot** option and complete the installation wizard setup.
14+
3. Disable **Network (PXE)** from the Device42 virtual machine **Boot Options**.
15+
4. Log in to the Device42 console and web interface as described in the [Set Up the Main Appliance](installation-xen-or-kvm-using-virt-manager.mdx#set-up-the-main-appliance-and-log-in) section and later of the Virt-Manager installation page.
16+
17+
## Illustrated Installation Steps
18+
19+
The following alternative installation steps are similar to the [standard Virt-Manager installation](getstarted/installation/installation-xen-or-kvm-using-virt-manager.mdx), except that you select the **Network Boot** option instead of importing the Device42 image and then disable the network boot.
20+
1021
### Download and Uncompress with bunzip2
1122

1223
The raw image for Xen or KVM has been compressed using bzip2. When you get the file on the KVM host, run the `bunzip2` command to uncompress the file:
@@ -19,31 +30,31 @@ bunzip2 device42-3.2.3-raw.img.bz2
1930

2031
Once you have uncompressed the downloaded raw image, create a new virtual machine.
2132

22-
Choose the **Network Boot** option. We'll add the disk later. Please make sure you don't have any kind of automated network boot enabled for this machine. You will not see the **Import existing disk image** option.
33+
Choose the **Network Boot** option. We'll add the disk later. Make sure you don't have some sort of automated network boot enabled for this machine. You will not see the **Import existing disk image** option.
2334

2435
![Install](/assets/images/wpid2483-Install.png)
2536

2637
### Choose OS and Version
2738

28-
Choose **Linux** as the **OS type** and **Ubuntu 14.04** for the **Version**. If you don't see the option for **14.04**, choose the latest version available.
39+
Choose **Linux** as the **OS type** and the latest Ubuntu version in the **Version** field.
2940

3041
![Choosing OS and version](/assets/images/wpid2480-Choosing_OS_and_version.png)
3142

32-
Allocate at least `8` GB RAM and `2` vCPU for production appliances. See the Device42 [Sizing Recommendations](sizing-recommendations.mdx) page for more information.
43+
Allocate at least 8 GB RAM and 2 vCPUs for production appliances. See [Sizing Recommendations](sizing-recommendations.mdx).
3344

3445
![](/assets/images/wpid2484-media_1326264722468.png)
3546

36-
### Choose Disk (bunzipped File)
47+
### Choose Disk
3748

38-
![Choose disk(bunzipped file)](/assets/images/wpid2479-Choose_disk_bunzipped_file_.png)
49+
![Choose disk](/assets/images/wpid2479-Choose_disk_bunzipped_file_.png)
3950

4051
Choose your virtualization type under the **Advanced options** and select **i686** as the **Architecture**.
4152

4253
![](/assets/images/wpid2487-media_1352976855381.png)
4354

4455
### Disable Network Boot
4556

46-
Go to **Details** (1) > **Boot Options** (2), then uncheck **Network(PXE)** and click **Apply** (4).
57+
Go to **Details** (1), **Boot Options** (2), uncheck **Network (PXE)**, and click **Apply** (4).
4758

4859
![Disable network boot](/assets/images/wpid2481-Disable_network_boot.png)
4960

docs/getstarted/installation/index.mdx

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,38 @@
22
title: "Installation"
33
---
44

5-
:::danger
6-
IMPORTANT NOTICE: Device42 is delivered as a virtual appliance. Root access to the appliance is not supported, and the VM will cease to function if you attempt to break into the root account.
7-
:::
5+
Welcome to the Device42 installation guide. This page outlines installing Device42 for the purposes of mapping and gaining insight into your IT environment.
86

9-
In this section, we will discuss how to install Device42 and use it in your organization. To test Device42, we recommend you use the Device42 SaaS platform and properly provisioned and specced hardware. See the general [sizing recommendations](sizing-recommendations.mdx) for details. You can also sign up for a [free trial of Device42](https://www.device42.com/try-device42/) or [join us in a live demo](https://www.device42.com/weekly-demo/?nab=0).
7+
## Getting Started
108

11-
The subpages in this category provide platform-specific instructions for various providers, including AWS, Azure, and Citrix, and can be accessed via the sidebar.
9+
Device42 is delivered as a virtual appliance, which you install on a virtualization platform.
10+
11+
Before you begin:
12+
- Review the [sizing recommendations](sizing-recommendations.mdx) to ensure your environment is properly provisioned.
13+
- Visit the [security posture and high-level permissions](security-posture-and-high-level-permissions.mdx) page.
14+
- See the [discovery port configurations](discovery-port-configurations.mdx) for network requirements.
15+
16+
## Installation Process Overview
17+
18+
Device42 consists of three components to install. First, install the Device42 Main Appliance (the Device42 application and user interface), followed by the Remote Collector (RC) and Windows Discovery Service (WDS).
19+
20+
When you run a discovery, the Device42 MA uses the WDS to collect information about Windows environments and uses the RC to collect information about all other IT environments.
21+
22+
See the next [Resource and Deployment Architecture](resource-and-deployment-architecture-overview.mdx) page for more information about these core Device42 components and how they fit together.
23+
24+
After you install the Main Appliance, RC, and WDS, you can install the [Device42 NetFlow Collector](installing-the-d42-netflow-collector-as-a-service.mdx) to improve [Application Dependency Mapping](/apps/enterprise-application-dependency-mapping/index.mdx) discovery.
25+
26+
## Choose Your Platform
27+
28+
Select the platform-specific installation guide from the sidebar that matches your environment:
29+
30+
- [VMware vCenter Server](installation-vcenter-server.mdx)
31+
- [Microsoft Hyper-V](installation-microsoft-hyperv.mdx)
32+
- [Citrix Xen Server](installation-citrix-xen-server.mdx)
33+
- [Xen or KVM](installation-xen-or-kvm-using-virt-manager.mdx)
34+
- [Amazon Web Services (AWS)](installation-amazon-web-services.mdx)
35+
- [Microsoft Azure](installation-microsoft-azure.mdx)
36+
37+
## Try Device42
38+
39+
Sign up for a [free trial of Device42](https://www.device42.com/try-device42/) or [join us in a live demo](https://www.device42.com/weekly-demo/?nab=0) to see the platform in action.

docs/getstarted/installation/installation-amazon-web-services.mdx

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
---
22
title: "Amazon Web Services - Installation"
3-
sidebar_position: 9
3+
sidebar_position: 10
44
---
55

66
import ThemedImage from '@theme/ThemedImage'
77
import useBaseUrl from '@docusaurus/useBaseUrl'
88
import loginImg from '/assets/images/installation-amazon-web-services/login-appliance-manager.png'
99

10-
## Overview
10+
The Device42 Amazon Web Services (AWS) offering involves an EC2 instance that houses the Device42 Main Appliance (MA), Appliance Manager (AM), and Remote Collector (RC).
1111

12-
The Device42 Main Appliance (MA) is available on Amazon Web Services (AWS), either as a manual installation or through the AWS Marketplace.
12+
![AWS architecture](/assets/images/aws-architecture.png)
1313

14-
The Device42 Remote Collector (RC) is only available via manual installation. To request access, please submit a ticket to the Device42 RC Amazon Machine Image (AMI) and include the following information:
14+
## Overview
1515

16-
- The AWS region for Device42 deployment.
17-
- The AWS account number.
16+
The Device42 Main Appliance is available on AWS, either as a manual installation or through the AWS Marketplace — this guide has instructions for both options.
1817

19-
The Device42 AWS offering involves an EC2 instance that houses the Device42 MA, Appliance Manager (AM), and RC.
18+
The Device42 RC is only available via manual installation only. To request access, please submit a ticket to the Device42 RC Amazon Machine Image (AMI) and include the following information:
2019

21-
![AWS architecture](/assets/images/aws-architecture.png)
20+
- The AWS region for Device42 deployment
21+
- The AWS account number
2222

2323
## Costs and Licensing
2424

@@ -316,9 +316,8 @@ The following is a sample IAM policy (with minimum appropriate permissions) that
316316
### Security, Privacy, and Other Considerations
317317

318318
- The Device42 AWS offering does not restrict the Instance Metadata Service version.
319-
- The Device42 AWS offering does not require AWS data encryption to operate properly.
319+
- The Device42 AWS offering does not require AWS data encryption to operate properly.
320320
- Customer data resides on the instance itself. Customer passwords and secrets are encrypted with AES-256 encryption.
321321

322322
Refer to the Device42 [Secrets, Security, and Permissions](administration/passwords/password-security-and-permissions.mdx) page for additional information on how passwords and secrets are stored.
323-
324323
- The Device42 AWS offering does not require the storage of any secrets in AWS Secrets Manager.
Lines changed: 84 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,115 @@
11
---
2-
title: "Citrix Xen Server - Installation"
3-
sidebar_position: 11
2+
title: "Citrix XenServer - Installation"
3+
sidebar_position: 7
44
---
55

66
import ThemedImage from '@theme/ThemedImage'
77
import useBaseUrl from '@docusaurus/useBaseUrl'
88

9-
Download the compressed [Device42 virtual appliance](https://www.device42.com/download/) and take following steps:
9+
This guide walks you through installing the Device42 Main Appliance on Citrix XenServer.
10+
11+
## Outline of Installation Steps
12+
13+
1. Download and unzip the compressed Device42 virtual appliance.
14+
2. From XenCenter, import the unzipped file.
15+
3. Follow the Citrix prompts and choose your server, storage location, and network card.
16+
4. Power on the newly deployed Device42 virtual appliance.
17+
5. Log in to the Device42 console using the default credentials and update the credentials.
18+
6. Configure the static IP address from the console.
19+
7. Log in to the Device42 web interface from a browser: `https://FQDN (Fully Qualified Domain Name) or IP address`. Update the login credentials here as well.
20+
21+
## Illustrated Steps of Installing Device42 on Citrix XenServer
22+
23+
Set up your Device42 instance by following these steps.
24+
25+
### Download and Unzip Device42
26+
27+
Download the compressed [Device42 virtual appliance](https://www.device42.com/download/) and connect to your XenCenter.
28+
29+
Use 7-Zip to decompress the downloaded Device42 virtual appliance image.
30+
31+
### Import Device42 into XenCenter
32+
33+
From XenCenter, right-click the server's name and select **Import**.
1034

11-
1. Use 7zip to unzip the downloaded file.
12-
2. From XenCenter, right-click the server's name and select **Import**.
13-
1435
![Here are the steps in Images:](/assets/images/wpid5942-wpid-media_1331243551635.png)
1536

16-
3. Choose Source.
17-
37+
Choose the source file you downloaded.
38+
1839
![Locate the file you you downloaded](/assets/images/wpid5943-wpid-media_1331243622364.png)
1940

20-
4. Choose Server.
41+
### Configure Server, Storage, and Network
42+
43+
Choose your server (or accept the default pool).
2144

2245
![Choose a pool, or accept the default (next)](/assets/images/wpid5944-wpid-media_1331243664174.png)
2346

24-
5. Choose Storage.
25-
47+
Choose a storage location for the VM.
48+
2649
![Choose a storage location for the VM](/assets/images/wpid5945-wpid-media_1331243689911.png)
2750

28-
6. Choose the network card and click **Finish**.
29-
51+
Choose the network card and click **Finish**.
52+
3053
![Choose the network to connect the VM to](/assets/images/wpid5946-wpid-media_1331243717545.png)
3154
![Click finish](/assets/images/wpid5947-wpid-media_1331243745178.png)
3255

33-
7. Power on the VM and log in to the console with the default credentials:
56+
### Start the Device42 VM
57+
58+
Power on your newly deployed Device42 virtual appliance.
59+
60+
### Log In to the Device42 Console
61+
62+
From the XenCenter interface, open the VM console for your Device42 appliance. The Device42 console login screen will appear automatically.
63+
64+
Log in using the default credentials and change them after logging in:
3465

3566
- **Username:** `device42`
36-
- **Password:** `adm!nd42`
37-
38-
**Change the default password using option 10 on the appliance console.**
67+
- **Password:** `adm!nd42`
68+
69+
_(Deprecated appliance logins: 32-bit: ubuntu/adm!nd42 -- Power: ubuntu/default)._
3970

40-
_(Deprecated appliance logins: 32-bit: ubuntu/adm!nd42 -- Power: ubuntu/default)._
71+
### Configure the Static IP Address
4172

42-
![Log in to the VM Console](/assets/images/wpid5950-media_1419606545144.png)
73+
From the console, configure the IP address. Use a **static IP** for all production Device42 VMs to avoid connectivity issues.
4374

44-
8. Choose option **U** to configure networking.
45-
4675
![Device42 VM console menu v19.05](/assets/images/vm-main-menu.png)
4776

48-
To avoid connectivity issues, please use a static IP address for all production Device42 Installations.
77+
Enter your settings on the Device42 IP address configuration screen:
78+
79+
![IP config options](/assets/images/vm-ip-settings.png)
80+
81+
### Create a DNS Entry
82+
83+
This is an optional step: Create a DNS entry for the new IP address of the virtual appliance.
84+
85+
### Log In to the Web Interface
86+
87+
Point your browser to `https://FQDN (Fully Qualified Domain Name) or IP address`.
88+
89+
Log in to the **web interface** using the default credentials:
90+
91+
- **Username:** `admin`
92+
- **Password:** `adm!nd42`
93+
94+
Please change the username and password as soon as you log in.
95+
96+
<ThemedImage
97+
alt="Device42 Web Interface Login Screen v19.05"
98+
sources={{
99+
light: useBaseUrl('/assets/images/login-19.05-light.png'),
100+
dark: useBaseUrl('/assets/images/login-19.05-dark.png'),
101+
}}
102+
style={{ width: '70%' }}
103+
/>
104+
105+
You should be up and running, and are now ready to go! If you have any questions that you can't find answers to in the docs, email [[email protected]](mailto:[email protected]).
49106

50-
![IP config options v19.05](/assets/images/vm-ip-settings.png)
107+
## Using SSH
51108

52-
9. The default password for user `device42` can now be changed from the console menu using option number **10**.
53-
54-
You can apply updates and do other menu-related work using SSH **port 404**. Please note that root login has been disabled via SSH. Attempting to access the root will cause the VM to disable itself permanently and is not supported.
55-
10. Point your browser to `https://FQDN(Fully Qualified Domain Name) or IP-address`.
56-
11. Log in to the **web interface** using the default credentials:
109+
You can apply updates and do other menu-related work using SSH port 404. Please note that root login has been disabled via SSH. Attempting to access the root will cause the VM to disable itself permanently and is not supported.
57110

58-
- **Username** `admin`
59-
- **Password:** `adm!nd42`
111+
## Next Steps
60112

61-
**Please change the username and password as soon as you log in.**
113+
Install the Device42 [Remote Collector](remote-collector-rc-installation.mdx) and [Windows Discovery Service](windows-discovery-service-installation.mdx) before creating your first discovery job.
62114

63-
<ThemedImage
64-
alt="Device42 UI Login Screen v19.05"
65-
sources={{
66-
light: useBaseUrl('/assets/images/login-19.05-light.png'),
67-
dark: useBaseUrl('/assets/images/login-19.05-dark.png'),
68-
}}
69-
style={{ width: '70%' }}
70-
/>
115+
You can import data into Device42 using the [Device42 API](https://api.device42.com/) or the [**Import/Export (xls)**](/getstarted/tutorials/tutorial-loading-data-using-spreadsheets.mdx) tool.

0 commit comments

Comments
 (0)