Skip to content

Commit

Permalink
Merge pull request #333 from ritza-co/docs-18.14.4
Browse files Browse the repository at this point in the history
Docs v18.14.4 release (week 17, 2024)
  • Loading branch information
sixhobbits authored May 9, 2024
2 parents 83b7741 + 0410007 commit 9c68448
Show file tree
Hide file tree
Showing 69 changed files with 523 additions and 285 deletions.
2 changes: 1 addition & 1 deletion docs/administration/main-appliance-remote-collector-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ If you’re less than three versions behind, downloading the new MA file will br

## If I am on the latest MA release, how do I update my Remote Collectors?

This update will need to be pushed via the Appliance Manager once you have the upgrade file. Step by step instructions can be found here: [https://docs.device42.com/getstarted/faqs/](getstarted/faqs/index.md).
This update will need to be pushed via the Appliance Manager once you have the upgrade file. Step by step instructions can be found here: [https://docs.device42.com/getstarted/faqs/](/getstarted/faqs/index.mdx).

## How is the Remote Collector proxy configured?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 3

## Turning on Application Discovery

To turn on Enterprise Application Mapping, simply check the "Discover Applications" checkbox while configuring your discovery job. If you are new to discovery, see [Getting Started with Auto-Discovery](getstarted/getting-started-with-auto-discovery.md) to get acquainted. If you would like to discover config files, they can also be imported into Device42; select the "Store Application Components Config Files" checkbox.
To turn on Enterprise Application Mapping, simply check the "Discover Applications" checkbox while configuring your discovery job. If you are new to discovery, see [Getting Started with Auto-Discovery](/getstarted/getting-started-with-auto-discovery.mdx) to get acquainted. If you would like to discover config files, they can also be imported into Device42; select the "Store Application Components Config Files" checkbox.

When autodiscovery is run, Application Components will be created based on related services on a server. For instance, a server with Oracle Database running will have a component created that associates all Oracle Database services together on that machine. The Autodiscovery Application will also find the service-to-service connections so you could, for example, see that your Apache service on _Prod-Server1_ is directly dependent on the MySQL service running on _Prod-Database3_.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,55 +3,85 @@ title: "Google Cloud Platform Autodiscovery"
sidebar_position: 4
---

import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from '@docusaurus/useBaseUrl'

### GCP Discovery Items

<table><tbody><tr><td><strong>Cloud Service/Object Name</strong></td><td><strong>&nbsp;Name</strong> <strong>Where to locate in D42</strong></td><td><strong>Accessed API</strong></td><td><strong>Information</strong>&nbsp;<strong>Generated</strong></td></tr><tr><td>K8s (GKE) Discovery</td><td>Devices –&gt; Unknown</td><td><a href="https://www.googleapis.com/discovery/v1/apis/compute/v1/rest">https://www.googleapis.com/discovery/v1/apis/compute/v1/rest</a> <a href="https://www.googleapis.com/discovery/v1/apis/container/v1/rest">https://www.googleapis.com/discovery/v1/apis/container/v1/rest</a></td><td>Containers, pods, clusters</td></tr><tr><td>Networks (as VRF Groups)</td><td>Network --&gt; VRF Groups</td><td><a href="https://www.googleapis.com/discovery/v1/apis/compute/v1/rest">https://www.googleapis.com/discovery/v1/apis/compute/v1/rest</a></td><td>Name</td></tr><tr><td>Subnets</td><td>Networks --&gt; Subnets</td><td><a href="https://www.googleapis.com/discovery/v1/apis/compute/v1/rest">https://www.googleapis.com/discovery/v1/apis/compute/v1/rest</a></td><td>Mask, name, VRF Group</td></tr><tr><td>SQL DB</td><td>&nbsp;</td><td><a href="https://www.googleapis.com/discovery/v1/apis/sqladmin/v1beta4/rest">https://www.googleapis.com/discovery/v1/apis/sqladmin/v1beta4/rest</a></td><td>Tables, instances, etc.</td></tr><tr><td>VMs</td><td>Devices --&gt; All Devices</td><td><a href="https://www.googleapis.com/discovery/v1/apis/compute/v1/rest">https://www.googleapis.com/discovery/v1/apis/compute/v1/rest</a></td><td>Type, Name, RAM, OS, CPU, cores, etc.</td></tr></tbody></table>
| Cloud Service/Object Name | Name Where to locate in D42 | Accessed API | Information Generated |
|----------------------------|------------------------------|--------------|-----------------------|
| K8s (GKE) Discovery | Devices -> Unknown | [Compute API](https://www.googleapis.com/discovery/v1/apis/compute/v1/rest), [Container API](https://www.googleapis.com/discovery/v1/apis/container/v1/rest) | Containers, pods, clusters |
| Networks (as VRF Groups) | Network -> VRF Groups | [Compute API](https://www.googleapis.com/discovery/v1/apis/compute/v1/rest) | Name |
| Subnets | Networks -> Subnets | [Compute API](https://www.googleapis.com/discovery/v1/apis/compute/v1/rest) | Mask, name, VRF Group |
| SQL DB | | [SQL Admin API](https://www.googleapis.com/discovery/v1/apis/sqladmin/v1beta4/rest) | Tables, instances, etc. |
| VMs | Devices -> All Devices | [Compute API](https://www.googleapis.com/discovery/v1/apis/compute/v1/rest) | Type, Name, RAM, OS, CPU, cores, etc. |

### Pre-requisites

For Google Cloud Discovery, you will need a user account with the built-in Google Cloud Platform Viewer role.
For Google Cloud Discovery, you will need a user account with the built-in Google Cloud Platform "Viewer" role.

### Configuring Google Cloud Discovery

Device42 can now discover your inventory on the Google Cloud Platform. Simply create a new job, add your credentials, and you'll be off discovering all of your GCP VMs. Begin by creating a new Google cloud discovery job:
Device42 can discover your inventory on the Google Cloud Platform. Simply create a new job, add your credentials, and you'll be off discovering all of your GCP VMs.

To create a new Google Cloud discovery job, go to **Discovery > Cloud** and click **+ Add Cloud Autodiscovery**.

![](/assets/images/Image_12_Cloud_Disc_Google_1.png)
<ThemedImage
alt="Add Google Cloud discovery form"
sources={{
light: useBaseUrl("/assets/images/google-cloud-platform-autodiscovery/add-cloud-autodiscovery-light.png"),
dark: useBaseUrl("/assets/images/google-cloud-platform-autodiscovery/add-cloud-autodiscovery-dark.png"),
}}
/>

1) Create a new _"Cloud Autodiscovery"_ job from the _Discovery_, and choose _Google Cloud._
1. Choose **Google Cloud** as the discovery **Type**.

2) Browse to your Google Cloud Engine JSON keyfile. Open it in a text editor and copy the contents:
2. Browse to your Google Cloud Engine JSON key. Open it in a text editor and copy the contents:

![](/assets/images/Image_13_Cloud_Disc_Google_2.png)
![Google Cloud Engine JSON key](/assets/images/google-cloud-platform-autodiscovery/google-json-key.png)

3) Paste the copied JSON in its entirety into the password field:
3. Paste the copied JSON in its entirety into the **Credentials JSON** field:

![](/assets/images/Image_14_Cloud_Disc_Google_3.png)
<ThemedImage
alt="Add JSON as new Secret"
sources={{
light: useBaseUrl("/assets/images/google-cloud-platform-autodiscovery/add-json-key-light.png"),
dark: useBaseUrl("/assets/images/google-cloud-platform-autodiscovery/add-json-key-dark.png"),
}}
/>

4) Save and run your job! Optionally, create a schedule to run it automatically!
4. Save and run your job. Optionally, create a schedule to run it automatically.

_Data discovered on the Google Cloud Platform is similar to what you might be used to on AWS EC2 instances, namely:_
Data discovered on the Google Cloud Platform is similar to what you might be familiar with on AWS EC2 instances, namely:

- Discovered Google Cloud VMs are added as virtual devices
- Cloud information is added inline in Device42 for each CI
- Discovered Google Cloud VMs are added as virtual devices.
- Cloud information is added inline in Device42 for each CI.

**Options for GCE are as follows:**

- Select Kubernetes Discovery to discover Kubernetes clusters hosted on your cloud platform.
- Select **Kubernetes Discovery** to discover Kubernetes clusters hosted on your cloud platform.

![](/assets/images/K8s-Discovery-Option_AWSAzureGoogle.png)
<ThemedImage
alt="Kubernetes Discovery option"
sources={{
light: useBaseUrl("/assets/images/google-cloud-platform-autodiscovery/kubernetes-discovery-option-light.png"),
dark: useBaseUrl("/assets/images/google-cloud-platform-autodiscovery/kubernetes-discovery-option-dark.png"),
}}
style={{ width: '70%' }}
/>

- Strip Domain Name: Strip domain name from discovered name (everything after the first period)
- Object category for discovered devices: Choose a category to assign to discovered devices
- Overwrite existing object categories: Select this option to overwrite any previously assigned categories with current selection
- **Strip Domain Name:** Strip the domain name from the discovered name (everything after the first period).
- **Object category for discovered devices:** Choose a category to assign to discovered devices.
- **Overwrite existing object categories:** Select this option to overwrite any previously assigned categories with the current selection.

**Service Level Option**

You can set the **Service Level** (for example, "Development", "Deployment", or "Production") of the job to be applied to the discovered items. See [Service Level and Object Category Options](index.mdx#service-level-and-object-category-options) for details.

### GCP Account Tags

Select your Google cloud account from the list page under **Infrastructure > Cloud Infrastructure > Cloud Accounts**.
Select your Google Cloud account from the list page under **Infrastructure > Cloud Infrastructure > Cloud Accounts**.

If available, the discovered account-level tags will be listed under the **Vendor Custom Fields** section.

![GCP cloud account tags](/assets/images/GCP-tags.png)
![GCP cloud account tags](/assets/images/GCP-tags.png)
14 changes: 9 additions & 5 deletions docs/auto-discovery/enrichai-data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,18 @@ In addition, if the entry is new or unique, it may require the EnrichAI service
}
]
```
## Using the EnrichAI Interface
## EnrichAI Connectivity

The Main Appliance will need to be able to reach the following domains for cloud services to be registered:
Please make sure the following is in place to ensure connectivity with EnrichAI:

- `https://registration.device42.com`
- `https://crs.device42.io/`
- `https://enrichai.device42.io/api/normalizations`
1. Configure the Cloud Connector and ensure it is reachable.
2. Ensure that the EnrichAI endpoints are reachable, including the registration endpoint:
- `https://registration.device42.com`
- `https://crs.device42.io/`
- `https://enrichai.device42.io/api/normalizations`
3. Register the license online.

## Using the EnrichAI Interface

Select **Analytics > EnrichAI Data** to display the EnrichAI Data list page.

Expand Down
Loading

0 comments on commit 9c68448

Please sign in to comment.