Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs v18.14.4 release (week 17, 2024) #333

Merged
merged 40 commits into from May 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
81a2460
DOCS-341 add assets page, assets
Nadia-JSch Apr 19, 2024
f678708
DOCS-349 page updates, export-records
Nadia-JSch Apr 19, 2024
4070f9b
DOCS-347 update images and convert table to md, google-cloud-platform…
Nadia-JSch Apr 19, 2024
98b47a4
change to .mdx
Nadia-JSch Apr 19, 2024
e26db5f
DOCS-348 update page, spreadsheet-imports-and-exports
Nadia-JSch Apr 19, 2024
46b88af
change to .mdx
Nadia-JSch Apr 19, 2024
58d5462
reword intro sentence
Nadia-JSch Apr 19, 2024
564f0fa
DOCS-105 update page, getting-started-with-auto-discovery
Nadia-JSch Apr 23, 2024
1adddbb
change to .mdx
Nadia-JSch Apr 23, 2024
e9cc455
DOCS-350 clarify connectivity steps, enrichai-data
Nadia-JSch Apr 23, 2024
6e5301e
DOCS-354 update unknown type section, faqs
Nadia-JSch Apr 24, 2024
5c00ec6
change to .mdx & update link
Nadia-JSch Apr 24, 2024
c90b3a2
DOCS-356 update dashboard image, device42-tutorial
Nadia-JSch Apr 24, 2024
1c05797
change to .mdx & update links
Nadia-JSch Apr 24, 2024
391703c
DOCS-361 format and edit for readability, deployment-best-practices
Nadia-JSch Apr 25, 2024
8cb4055
DOCS-350 reword new connectivity section steps
Nadia-JSch Apr 25, 2024
b3ef7db
Deployment Best Practices language edit
worktheclock Apr 25, 2024
a4f28d5
Assets language edit
worktheclock Apr 25, 2024
7acce17
Export Records proofread
worktheclock Apr 25, 2024
d53e132
GCP Autodiscovery proofread
worktheclock Apr 25, 2024
3a8bfde
Spreadsheet Imports proofread
worktheclock Apr 25, 2024
fdfddde
Getting Started Autodiscovery proofread
worktheclock Apr 25, 2024
e7a839c
New FAQ section proofread
worktheclock Apr 25, 2024
757694b
Merge pull request #136 from ritza-co/export-records-proofread
Nadia-JSch Apr 26, 2024
f1d6b62
Merge pull request #135 from ritza-co/assets-language-edit
Nadia-JSch Apr 26, 2024
f6de3e7
Merge pull request #134 from ritza-co/deployment-best-practices-langu…
Nadia-JSch Apr 26, 2024
1898410
Merge pull request #137 from ritza-co/gcp-autodiscovery-proofread
Nadia-JSch Apr 26, 2024
94a68a4
Merge pull request #138 from ritza-co/spreadsheet-imports-proofread
Nadia-JSch Apr 26, 2024
db7dafd
Merge pull request #139 from ritza-co/getting-started-autodiscovery-p…
Nadia-JSch Apr 26, 2024
632279b
Merge pull request #140 from ritza-co/new-faq-section-proofread
Nadia-JSch Apr 26, 2024
92e89ed
Merge pull request #122 from ritza-co/341-new-asset-pg
Nadia-JSch Apr 26, 2024
a900c54
Merge pull request #123 from ritza-co/349-export-records
Nadia-JSch Apr 26, 2024
8a8f476
Merge pull request #124 from ritza-co/347-update-google-cloud
Nadia-JSch Apr 26, 2024
2c54b0d
Merge pull request #125 from ritza-co/docs-348-spreadsheets
Nadia-JSch Apr 26, 2024
d15ae8d
Merge pull request #127 from ritza-co/105-update-getting-started
Nadia-JSch Apr 26, 2024
8544cd0
Merge pull request #129 from ritza-co/354-getstarted-faqs
Nadia-JSch Apr 26, 2024
96af0aa
Merge pull request #130 from ritza-co/356-tutorial
Nadia-JSch Apr 26, 2024
e7a3d33
Merge pull request #132 from ritza-co/361-deployment-best-prac
Nadia-JSch Apr 26, 2024
a3cb584
Merge pull request #133 from ritza-co/350-enrich-ai
Nadia-JSch Apr 26, 2024
0410007
correct link
Nadia-JSch Apr 26, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/administration/main-appliance-remote-collector-faq.md
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
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
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
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