diff --git a/docs/connecting_github.md b/docs/connecting_github.md index 41450eed..7f1b59ae 100644 --- a/docs/connecting_github.md +++ b/docs/connecting_github.md @@ -13,13 +13,8 @@ import TabItem from '@theme/TabItem'; # GitHub -:::note -The following documentation is provided for early access users. -::: - Vantage ingests GitHub costs via a Vantage-owned billing manager account that users add to their GitHub Organization or Enterprise. The billing manager account _has no access_ to any source code. - With the Vantage–GitHub integration, you can track costs from the following GitHub services: GitHub Actions, Shared Storage, and Copilot. In addition to these services, Vantage can also pull the underlying compute costs for self-hosted runners that run on a virtual machine, such as an EC2 instance, or in Kubernetes. ## How Vantage Integrates with GitHub @@ -171,3 +166,11 @@ You can also view GitHub credits in Cost Reports. 1. At the top of any GitHub Cost Report, click **Settings**. 2. Then, toggle on/off **Credits**. + +## GitHub Costs Demonstration + +The below video talks about how to get started with GitHub costs and how to use [Virtual Tags](/virtual_tagging) along with this integration. + +
+ +

diff --git a/docs/data_dictionary.md b/docs/data_dictionary.md index 5ca9592a..de9983f8 100644 --- a/docs/data_dictionary.md +++ b/docs/data_dictionary.md @@ -14,9 +14,9 @@ Each provider that Vantage integrates with makes different fields available in t Each provider table contains four columns: Filter, API Field Name, Data Type, and `namespace.field`. -- The Filter is the friendly name that is displayed on Cost Report filters within the Vantage console. -- The API Field Name is the normalized version of the filter name. -- The Data Type indicates the type of data that is accepted for that field. +- The _Filter_ is the friendly name that is displayed on Cost Report filters within the Vantage console. +- The _API Field Name_ is the normalized version of the filter name. +- The _Data Type_ indicates the type of data that is accepted for that field. - `namespace.field` is how that field is referenced in a VQL query (e.g., `costs.provider = 'aws'`, where `costs` is the namespace and `provider` is the field). :::info @@ -37,6 +37,7 @@ Each cost provider also has a normalized name within the API. The `provider` fie | Databricks | `databricks` | [View Databricks Fields](#databricks) | | Datadog | `datadog` | [View Datadog Fields](#datadog) | | Fastly | `fastly` | [View Fastly Fields](#fastly) | +| GitHub | `github` | [View GitHub Fields](#github) | | Google Cloud | `gcp` | [View GCP Fields](#google-cloud-platform) | | Kubernetes | `kubernetes` | [View Kubernetes Fields](#kubernetes) | | MongoDB Atlas | `mongo` | [View MongoDB Atlas Fields](#mongodb-atlas) | @@ -93,6 +94,7 @@ To reference a [Custom Provider](/connecting_custom_providers) in VQL queries, n | Charge Type | `charge_type` | string | `costs.charge_type` | | Tag\* | `name` | string | `tags.name` | | Tag Value\* | `value` | string | `tags.value` | +| Provider | `provider` | string | `costs.provider` | _\* Virtual tags associated with this provider_ @@ -107,6 +109,7 @@ _\* Virtual tags associated with this provider_ | Charge Type | `charge_type` | string | `costs.charge_type` | | Tag\* | `name` | string | `tags.name` | | Tag Value\* | `value` | string | `tags.value` | +| Provider | `provider` | string | `costs.provider` | _\* Virtual tags associated with this provider_ @@ -124,6 +127,7 @@ Available fields are based on what you've uploaded for this Custom Provider. See | Charge Type | `charge_type` | string | `costs.charge_type` | | Tag\* | `name` | string | `tags.name` | | Tag Value\* | `value` | string | `tags.value` | +| Provider | `provider` | string | `costs.provider` | _\* Regular and virtual tags associated with this provider_ @@ -138,6 +142,7 @@ _\* Regular and virtual tags associated with this provider_ | Tag Value | `value` | string | `tags.value` | | Category | `category` | string | `costs.category` | | Charge Type | `charge_type` | string | `costs.charge_type` | +| Provider | `provider` | string | `costs.provider` | ## Datadog {#datadog} @@ -167,6 +172,19 @@ _\* Regular and virtual tags associated with this provider_ _\* Virtual tags associated with this provider_ +## GitHub {#github} + +| Filter | API Field Name | Data Type | `namespace.field` | +| ----------- | -------------- | --------- | ------------------- | +| Service | `service` | string | `costs.service` | +| Provider | `provider` | string | `costs.provider` | +| Category | `category` | string | `costs.category` | +| Subcategory | `subcategory` | string | `costs.subcategory` | +| Resource | `resource_id` | string | `costs.resource_id` | +| Charge Type | `charge_type` | string | `costs.charge_type` | +| Tag | `name` | string | `tags.name` | +| Tag Value | `value` | string | `tags.value` | + ## Google Cloud {#google-cloud-platform} | Filter | API Field Name | Data Type | `namespace.field` | @@ -206,6 +224,7 @@ _\* Virtual tags associated with this provider_ | Charge Type | `charge_type` | string | `costs.charge_type` | | Tag | `name` | string | `tags.name` | | Tag Value | `value` | string | `tags.value` | +| Provider | `provider` | string | `costs.provider` | ## New Relic {#new-relic} @@ -217,6 +236,7 @@ _\* Virtual tags associated with this provider_ | Charge Type | `charge_type` | string | `costs.charge_type` | | Tag\* | `name` | string | `tags.name` | | Tag Value\* | `value` | string | `tags.value` | +| Provider | `provider` | string | `costs.provider` | _\* Virtual tags associated with this provider_ @@ -246,6 +266,7 @@ _\* Virtual tags associated with this provider_ | Charge Type | `charge_type` | string | `costs.charge_type` | | Tag\* | `name` | string | `tags.name` | | Tag Value\* | `value` | string | `tags.value` | +| Provider | `provider` | string | `costs.provider` | _\* Virtual tags associated with this provider_ diff --git a/docs/getting_started.md b/docs/getting_started.md index 77ee6a10..f527967f 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -128,6 +128,13 @@ Next, create a data integration between at least one of your providers and Vanta content: 'Vantage integrates with your Coralogix account through a revocable read-only API key and your Coralogix domain.', link: "/connecting_coralogix", }, + { + icon: '/img/logos/logo-icon-github.svg', + iconAltText: 'GitHub logo', + title: 'GitHub', + content: 'Vantage integrates with GitHub via a Vantage-owned billing manager account that users add to their GitHub Organization or Enterprise.', + link: "/connecting_github", + }, { icon: '/img/logos/logo-icon-custom-providers.svg', iconAltText: 'Custom Providers logo', diff --git a/docs/vantage_university_integrations.md b/docs/vantage_university_integrations.md index fca7e49f..bd615e06 100644 --- a/docs/vantage_university_integrations.md +++ b/docs/vantage_university_integrations.md @@ -34,6 +34,12 @@ Vantage offers a number of native integrations to help you understand all your c
+## 📚 Lesson 3: Integration Example - GitHub + +
+ +

+ ## 📖 Additional Resources - [Integrations quickstart](/getting_started) diff --git a/sidebars.js b/sidebars.js index 1cc71f13..dbb620ff 100644 --- a/sidebars.js +++ b/sidebars.js @@ -151,6 +151,7 @@ module.exports = { "connecting_confluent", "connecting_planetscale", "connecting_coralogix", + "connecting_github", "connecting_custom_providers", ], }, diff --git a/static/img/logos/logo-icon-github.svg b/static/img/logos/logo-icon-github.svg new file mode 100644 index 00000000..e075ea29 --- /dev/null +++ b/static/img/logos/logo-icon-github.svg @@ -0,0 +1,10 @@ + + + + + + + + + +