You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/auto-discovery/cloud-auto-discovery/google-cloud-platform-autodiscovery.mdx
+37Lines changed: 37 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,8 @@ sidebar_position: 4
6
6
importThemedImagefrom'@theme/ThemedImage'
7
7
importuseBaseUrlfrom'@docusaurus/useBaseUrl'
8
8
9
+
Use Device42's Google Cloud Platform (GCP) autodiscovery to automatically inventory your GCP infrastructure, including virtual machines, Kubernetes clusters, databases, networks, and load balancers.
10
+
9
11
## Google Cloud Platform Discovery Items
10
12
11
13
The following table outlines the Google Cloud Platform (GCP) items that Device42 automatically discovers, the types of information generated for each item, and where that information can be found in Device42.
@@ -18,6 +20,41 @@ The following table outlines the Google Cloud Platform (GCP) items that Device42
18
20
| SQL DB ||[SQL Admin API](https://www.googleapis.com/discovery/v1/apis/sqladmin/v1beta4/rest)| Tables, instances, etc. |
19
21
| VMs | Devices -> All Devices |[Compute API](https://www.googleapis.com/discovery/v1/apis/compute/v1/rest)| Type, Name, RAM, OS, CPU, cores, etc. |
20
22
23
+
Device42 also discovers the following GCP items:
24
+
25
+
**Storage:**
26
+
- Cloud Device
27
+
- Cloud Disk
28
+
29
+
**Networking:**
30
+
- VPCs (VRF Groups)
31
+
- VPC Firewall Rules
32
+
- GCP Load Balancer
33
+
34
+
**Databases:**
35
+
- Cloud SQL
36
+
- GCP BigQuery Table
37
+
38
+
**Kubernetes:**
39
+
- Kubernetes Cluster
40
+
- Kubernetes Config Map
41
+
- Kubernetes Container
42
+
- Kubernetes Daemon Set
43
+
- Kubernetes Deployment
44
+
- Kubernetes Ingress
45
+
- Kubernetes Ingress Rule
46
+
- Kubernetes Namespace
47
+
- Kubernetes Node
48
+
- Kubernetes Persistent Volume
49
+
- Kubernetes Pod
50
+
- Kubernetes Quota
51
+
- Kubernetes Replica Set
52
+
- Kubernetes Replication Controller
53
+
- Kubernetes Service
54
+
- Kubernetes Service Port
55
+
- Kubernetes Stateful Set
56
+
- Kubernetes Volume
57
+
21
58
## GCP Permission Requirements
22
59
23
60
The following permissions are required to perform a GCP discovery job. You can create a custom IAM role with these permissions or ensure they are included in existing roles granted to your account or service account.
Copy file name to clipboardExpand all lines: docs/integration/external-integrations/aperture-vista-to-device42-migration.mdx
+18-16Lines changed: 18 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,42 +3,44 @@ title: "Aperture VISTA to Device42 Migration"
3
3
sidebar_position: 1
4
4
---
5
5
6
-
The Aperture VISTA to Device42 migration works in the following manner: Data is exported from the Aperture VISTA application by first creating Device42 custom views in the Aperture SQL Server database. These views are then exported from Aperture VISTA and saved as .csv or Excel files which are then easily imported and mapped into Device42’s data architecture. (Aperture views can be downloaded here: [https://www.device42.com/migrations/aperture/](https://www.device42.com/migrations/aperture/).)
6
+
The Aperture VISTA to Device42 migration works in the following manner: Data is exported from the Aperture VISTA application by first creating Device42 custom views in the Aperture SQL Server database. These views are then exported from Aperture VISTA and saved as `.csv` or Excel files which are then easily imported and mapped into Device42's data architecture.
7
7
8
-
Device42 then automatically creates building, data center, and rack configurations for all rack mounted devices. With the import completed, Device42’s agentless autodiscovery tool automatically identifies and maps remaining IP-based network devices and intelligent power equipment for ongoing monitoring and management.
8
+
Aperture views can be downloaded here: [https://www.device42.com/migrations/aperture/](https://www.device42.com/migrations/aperture/).
9
9
10
-
### Import Views
10
+
Device42 then automatically creates building, data center, and rack configurations for all rack-mounted devices. With the import completed, Device42’s agentless autodiscovery tool automatically identifies and maps remaining IP-based network devices and intelligent power equipment for ongoing monitoring and management.
Device42 has developed a long list of SQL views to be able to give clients the ability to pick and choose the information they want to migrate to Device42 from Aperture VISTA.
16
+
A long list of SQL views is available to give you the ability to pick and choose the information you want to migrate to Device42 from Aperture VISTA.
15
17
16
-
To download the views click [here](https://www.device42.com/migrations/aperture/)
18
+
[Download the Aperture VISTA views](https://www.device42.com/migrations/aperture/).
By running the views you can easily get data out of your instance of Aperture VISTA
24
+
By running the views you can easily get data out of your instance of Aperture VISTA.
23
25
24
-
###Save Data to CSV or Excel
26
+
## Save Data to CSV or Excel
25
27
26
28
27
29
28
-
Very simply right click anywhere on the data and select "Save Results As..."
30
+
Right click anywhere on the data and select **Save Results As...**.
29
31
30
-
###Saving your file
32
+
## Saving Your File
31
33
32
-
34
+
33
35
34
-
Give the file a name and save the data locally
36
+
Give the file a name and save the data locally.
35
37
36
-
###Downloading the Bulk Import Tool to Map Fields
38
+
## Downloading the Bulk Import Tool to Map Fields
37
39
38
40
39
41
40
-
Click [here](https://www.device42.com/bulk-data-management/) to download the bulk import tool.
42
+
[Download the bulk import tool](https://www.device42.com/bulk-data-management/).
41
43
42
-
For instructions on how to use the bulk import tool to map your fields click [here](https://www.device42.com/blog/2015/07/02/bulk-import-your-data-from-any-format-easily-with-new-device42-import-tool/)
44
+
For instructions on how to use the Bulk Import Tool to map your fields, see the [bulk import tool documentation](https://www.device42.com/blog/2015/07/02/bulk-import-your-data-from-any-format-easily-with-new-device42-import-tool/).
43
45
44
-
If there are any questions please feel free to contact support: [email protected]
46
+
If you have any questions, contact support at [support@device42.com](mailto:[email protected]).
Copy file name to clipboardExpand all lines: docs/integration/external-integrations/cherwell-integration.mdx
+45-29Lines changed: 45 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,60 +3,76 @@ title: "Cherwell Integration"
3
3
sidebar_position: 4
4
4
---
5
5
6
-
**Device42-Cherwell integration requires** a working Cherwell installation, Device42 instance, and assumes a Linux server with python 3.5+.
6
+
Use the [Device42-Cherwell integration](https://www.device42.com/integrations/cherwell) to sync discovered infrastructure assets and configuration items (CIs) from Device42 to your Cherwell CMDB.
7
+
8
+
The Device42-Cherwell integration requires a working Cherwell installation, Device42 instance, and assumes a Linux server with Python version 3.5 or later.
7
9
8
10
## Configuring Cherwell
9
11
10
-
To prepare Cherwell to accept relationship data from Device42, two new CI types must be created within Cherwell: one for _apps_ & one for _services_. The following steps will create them:
12
+
To prepare Cherwell to accept relationship data from Device42, two new Configuration Item (CI) types must be created in Cherwell: one for **apps** and one for **services**.
13
+
14
+
Follow these steps to create the new CIs:
15
+
16
+
1. Open Cherwell Service Management Administrator and on the left-side menu under **Common Tasks**, choose **Create a new Blueprint** (optionally, edit an existing Blueprint):
17
+
18
+
19
+
20
+
2. Create a new CI type for Applications called `Config-Application` by clicking **New Business Object** and defining the object:
11
21
12
-
1. Open Cherwell Service Management Administrator and on the left-side menu under _"Common Tasks"_, choose _"Create a new Blueprint"_ (optionally, edit an existing Blueprint): 
13
-
2. Create a new CI type for Applications called `Config - Application` by clicking _"New Business Object"_ and defining the object: 
14
-
3. Obtain the "Internal ID" of the new Application CI Business Object you just created (you'll need it for the config file) before closing the window by selecting the "Advanced" icon and clicking _Business Object ID_: 
15
-
4. Edit the properties of your new Application Business Object CI, and add the fields `u_device42_id`, type 'text', size:15 & `u_device42_url`, type 'text', size:300: 
16
-
5. Add a second new CI business object named `Config - Service` to Cherwell for Services by repeating steps #2-4 again.
22
+
17
23
18
-
24
+
3. Obtain the **Internal ID** of the new Application Business Object CI you just created (you'll need it for the config file) before closing the window by selecting the **Advanced** icon and clicking **Business Object ID**:
19
25
20
-
## Configuring the D42-Cherwell integration
26
+
21
27
22
-
To sync your autodiscovered hardware, servers, software, services, and/or assets, etc. (CIs) from Device42 to Cherwell, configure the integration:
28
+
4. Edit the properties of your new Application Business Object CI, and add the fields `u_device42_id` of type `Text` and size `15`, and `u_device42_url`, of type `Text` and size `300`:
29
+
30
+
31
+
32
+
5. Add a second new CI business object named `Config-Service` to Cherwell for Services by repeating Steps 2-4.
33
+
34
+
## Configuring the Device42-Cherwell Integration
35
+
36
+
To sync your discovered hardware, servers, software, services, or assets (CIs) from Device42 to Cherwell, configure the integration:
23
37
24
38
1. Download the integration from the [Device42 Cherwell Integration page](https://www.device42.com/integrations/cherwell/), and unzip the folder to the directory of your choice.
25
-
2. Download the sample `mapping.xml` configuration file from [Device42's Github](https://github.com/device42/cherwell_device42_sync/blob/master/mapping.xml.sample) and put it into the folder you created in step 1.
39
+
2. Download the sample `mapping.xml` configuration file from [Device42's GitHub](https://github.com/device42/cherwell_device42_sync/blob/master/mapping.xml.sample) and put it into the folder you created in Step 1.
26
40
3. Configure the integration credentials to allow connection between Device42 and Cherwell:
27
41
- Save a copy of `mapping.xml.sample` as `mapping.xml`.
28
-
- Enter your Cherwell & Device42 **URLs**, **user names**, and **passwords** in their respective sections (lines 3-11), and for Cherwell only, the `client_id` - find it in your Cherwell instance: _Cherwell Service Management Administration -> Security -> Edit REST API Client Settings -> Client Key_
29
-
4. Configure the tasks section (below the credential settings) by entering the Cherwell Business Object IDs you saved from above, mapping each Device42 API resource to be synced (the `resource` value) to the appropriate fields in Cherwell (the `target` value). It is very important to ensure you've updated the configuration completely, mapping all of the details you are syncing from Device42 to their appropriate default endpoints in Cherwell (for example, service\_level). _Should you have trouble or need debugging, there is a `DEBUG` variable in `lib.py` which can be set to `True` or `False`._
42
+
- Enter your Cherwell and Device42 **URLs**, **user names**, and **passwords** in their respective sections (lines 3-11), and for Cherwell only, the `client_id` - find it in your Cherwell instance under **Cherwell Service Management Administration > Security > Edit REST API Client Settings > Client Key**.
43
+
4. Configure the tasks section (below the credential settings) by entering the Cherwell Business Object IDs you saved from above, mapping each Device42 API resource to be synced (the `resource` value) to the appropriate fields in Cherwell (the `target` value). It is very important to ensure you've updated the configuration completely, mapping all of the details you are syncing from Device42 to their appropriate default endpoints in Cherwell (for example, `service_level`). Should you have trouble or need debugging, there is a `DEBUG` variable in `lib.py` which can be set to `True` or `False`.
30
44
5. Execute a one-time CI sync by running the following command: `python sync.py`.
31
-
6. Schedule your syncs to run automatically by adding a `crontab` entry that will execute `sync.py` as often as you deem necessary, depending on the rate of change in your enviornment & existing discovery job schedules. This [crontab generator](https://crontab-generator.org/) can help you generate crontab syntax appropriate for your schedule. This example runs twice a day @ noon & midnight: `0 */12 * * * python sync.py >/dev/null 2>&1`
45
+
6. Schedule your syncs to run automatically by adding a `crontab` entry that will execute `sync.py` as often as you deem necessary, depending on the rate of change in your environment and existing discovery job schedules. This [crontab generator](https://crontab-generator.org/) can help you generate crontab syntax appropriate for your schedule. This example runs twice a day at noon and midnight:
32
46
33
-
47
+
```0 */12 * * * python sync.py >/dev/null 2>&1```
34
48
35
49
## Application Group Configuration for Cherwell
36
50
37
-
**The latest Device42 version is required**
51
+
The latest Device42 version is required.
52
+
53
+
Creation of Application Groups in Cherwell is not enabled by default. To enable Application Groups in `mapping.xml`, relevant attributes are as follows:
38
54
39
-
Creation of Application Groups in Cherwell is not enabled by default. To enable Application Groups in `mapping.xml`. Relevant Attributes are as follows:
55
+
-`Copy Application Group data from Device42 to Cherwell`: Can be `true` or `false`. Enable or disable Application Group mapping in Cherwell (disabled by default).
56
+
-`reset-connections`: Can be `true` or `false`. A setting of `true` resets all existing upstream and downstream service relationships, removing them from Cherwell before new relationships are processed (enabled by default).
40
57
41
-
-`Copy Application Group data from Device42 to Cherwell`: _true/false_. Enable/disable Application Group mapping in Cherwell - _disabled by default._
42
-
-`reset-connections`: _true/false_. A setting of `true` resets all existing upstream/downstream service relationships, removing them from Cherwell before new relationships are processed - _enabled by default_.
58
+
Tasks must contain at least the following three tags:
43
59
44
-
Tasks must contain at least the following 3 tags:
60
+
- For **Service Instances** (called `Config-Service CI` in Cherwell, `serviceinstance` in Device42)
61
+
- For **Application Components** (`Config-Application` CI in Cherwell, `appcomp` in Device42)
62
+
- For **Devices** (`device` in Device42).
45
63
46
-
1. For **Service Instances** (aka _Config-Service_\* CI in Cherwell; _serviceinstance_ in Device42)
47
-
2. For **Application Components** (aka _Config-Application_\* CI in Cherwell; _appcomp_ in Device42)
48
-
3. For **Devices** (aka _device_ in Device42). Several for devices can be present if devices are mapped to several CIs on Cherwell.
64
+
Multiple device entries can be present if devices are mapped to several CIs in Cherwell.
49
65
50
66
Each section must contain the following attributes:
51
67
52
-
-`d42-model`: the name of CI(model) in Device42
53
-
-`bus-ob-id`: the business object ID of CI in Cherwell
68
+
-`d42-model`: The name of the CI (model) in Device42
69
+
-`bus-ob-id`: The business object ID of CI in Cherwell
54
70
55
-
Each section must contain one or more upstream/downstream relationships (section). The section represents _1 `<->` Many_downstream relationship and has to contain the following attributes:
71
+
Each section must contain one or more upstream and downstream relationships. The section represents a one-to-many downstream relationship and must contain the following attributes:
56
72
57
-
-`d42-model`: the name of CI(model) in Device42 of the 'child' in relationship
58
-
-`id`: the ID of relationship (the _CI links Downstream CIs_ relationship should be used in common case). This value can be obtained in Cherwell from Cherwell service management administration -> blueprint -> Config - \* -> Edit relationships... -> relationship -> Edit -> Advanced -> Relationship ID. For proper working, please make sure that used relationship has the reversed one (_Upstream_).
73
+
-`d42-model`: The name of the CI (model) in Device42 of the 'child' in relationship
74
+
-`id`: The ID of the relationship (the `CI links Downstream CIs` relationship should be used in most cases). This value can be obtained in Cherwell from **Cherwell Service Management Administration > blueprint > Config > Edit relationships... > relationship > Edit > Advanced > Relationship ID**. Please make sure the relationship has a reversed one (`Upstream`).
59
75
60
-
The Service Instances and Application Components sections must include the section for creating new objects in Cherwell. Mappings are not applicable for devices since they should be processed in own tasks.
76
+
The Service Instances and Application Components sections must include the section for creating new objects in Cherwell. Mappings are not applicable for devices, as they should be processed in their own tasks.
61
77
62
78
Consult the examples in the `mapping.xml.sample` file.
0 commit comments