diff --git a/.gitbook/assets/adding-new-users-1.png b/.gitbook/assets/adding-new-users-1.png new file mode 100644 index 0000000..9ad7d74 Binary files /dev/null and b/.gitbook/assets/adding-new-users-1.png differ diff --git a/.gitbook/assets/adding-new-users-2.png b/.gitbook/assets/adding-new-users-2.png new file mode 100644 index 0000000..801ba2c Binary files /dev/null and b/.gitbook/assets/adding-new-users-2.png differ diff --git a/.gitbook/assets/connecting-aws-account-1-instructions.png b/.gitbook/assets/connecting-aws-account-1-instructions.png new file mode 100644 index 0000000..43bb530 Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-1-instructions.png differ diff --git a/.gitbook/assets/connecting-aws-account-2-a1-dialogue.png b/.gitbook/assets/connecting-aws-account-2-a1-dialogue.png new file mode 100644 index 0000000..c71eb3c Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-2-a1-dialogue.png differ diff --git a/.gitbook/assets/connecting-aws-account-2-a1.png b/.gitbook/assets/connecting-aws-account-2-a1.png new file mode 100644 index 0000000..fb69b30 Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-2-a1.png differ diff --git a/.gitbook/assets/connecting-aws-account-2-a2-dialogue.png b/.gitbook/assets/connecting-aws-account-2-a2-dialogue.png new file mode 100644 index 0000000..4f5782d Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-2-a2-dialogue.png differ diff --git a/.gitbook/assets/connecting-aws-account-2-a2.png b/.gitbook/assets/connecting-aws-account-2-a2.png new file mode 100644 index 0000000..5c0410e Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-2-a2.png differ diff --git a/.gitbook/assets/connecting-aws-account-2-b1-dialogue.png b/.gitbook/assets/connecting-aws-account-2-b1-dialogue.png new file mode 100644 index 0000000..858ad08 Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-2-b1-dialogue.png differ diff --git a/.gitbook/assets/connecting-aws-account-2-b1.png b/.gitbook/assets/connecting-aws-account-2-b1.png new file mode 100644 index 0000000..ade0364 Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-2-b1.png differ diff --git a/.gitbook/assets/connecting-aws-account-2-b2-dialogue.png b/.gitbook/assets/connecting-aws-account-2-b2-dialogue.png new file mode 100644 index 0000000..674e04a Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-2-b2-dialogue.png differ diff --git a/.gitbook/assets/connecting-aws-account-2-b2.png b/.gitbook/assets/connecting-aws-account-2-b2.png new file mode 100644 index 0000000..2caf451 Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-2-b2.png differ diff --git a/.gitbook/assets/connecting-aws-account-2-created.png b/.gitbook/assets/connecting-aws-account-2-created.png new file mode 100644 index 0000000..11f1cbb Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-2-created.png differ diff --git a/.gitbook/assets/connecting-aws-account-2-report-settings.png b/.gitbook/assets/connecting-aws-account-2-report-settings.png new file mode 100644 index 0000000..ee5352b Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-2-report-settings.png differ diff --git a/.gitbook/assets/connecting-aws-account-3-savings-2 (1).png b/.gitbook/assets/connecting-aws-account-3-savings-2 (1).png new file mode 100644 index 0000000..91d9424 Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-3-savings-2 (1).png differ diff --git a/.gitbook/assets/connecting-aws-account-3-savings-2.png b/.gitbook/assets/connecting-aws-account-3-savings-2.png new file mode 100644 index 0000000..91d9424 Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-3-savings-2.png differ diff --git a/.gitbook/assets/connecting-aws-account-3-savings.png b/.gitbook/assets/connecting-aws-account-3-savings.png new file mode 100644 index 0000000..92cc231 Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-3-savings.png differ diff --git a/.gitbook/assets/connecting-aws-account-3-welcome.png b/.gitbook/assets/connecting-aws-account-3-welcome.png new file mode 100644 index 0000000..be49cca Binary files /dev/null and b/.gitbook/assets/connecting-aws-account-3-welcome.png differ diff --git a/.gitbook/assets/connecting-gcp-project-1-instructions-2.png b/.gitbook/assets/connecting-gcp-project-1-instructions-2.png new file mode 100644 index 0000000..562206e Binary files /dev/null and b/.gitbook/assets/connecting-gcp-project-1-instructions-2.png differ diff --git a/.gitbook/assets/connecting-gcp-project-1-instructions-detailed.png b/.gitbook/assets/connecting-gcp-project-1-instructions-detailed.png new file mode 100644 index 0000000..5e5d8c2 Binary files /dev/null and b/.gitbook/assets/connecting-gcp-project-1-instructions-detailed.png differ diff --git a/.gitbook/assets/connecting-gcp-project-1-instructions.png b/.gitbook/assets/connecting-gcp-project-1-instructions.png new file mode 100644 index 0000000..763a321 Binary files /dev/null and b/.gitbook/assets/connecting-gcp-project-1-instructions.png differ diff --git a/.gitbook/assets/connecting-gcp-project-2-form.gif b/.gitbook/assets/connecting-gcp-project-2-form.gif new file mode 100644 index 0000000..e7985fb Binary files /dev/null and b/.gitbook/assets/connecting-gcp-project-2-form.gif differ diff --git a/.gitbook/assets/connecting-gcp-project-2-service-account-3.png b/.gitbook/assets/connecting-gcp-project-2-service-account-3.png new file mode 100644 index 0000000..fa886c4 Binary files /dev/null and b/.gitbook/assets/connecting-gcp-project-2-service-account-3.png differ diff --git a/.gitbook/assets/connecting-gcp-project-2-service-account-4.png b/.gitbook/assets/connecting-gcp-project-2-service-account-4.png new file mode 100644 index 0000000..8dee799 Binary files /dev/null and b/.gitbook/assets/connecting-gcp-project-2-service-account-4.png differ diff --git a/.gitbook/assets/connecting-gcp-project-2-service-account-5.png b/.gitbook/assets/connecting-gcp-project-2-service-account-5.png new file mode 100644 index 0000000..604ec4f Binary files /dev/null and b/.gitbook/assets/connecting-gcp-project-2-service-account-5.png differ diff --git a/.gitbook/assets/connecting-gcp-project-2-service-account-6.gif b/.gitbook/assets/connecting-gcp-project-2-service-account-6.gif new file mode 100644 index 0000000..f87d36c Binary files /dev/null and b/.gitbook/assets/connecting-gcp-project-2-service-account-6.gif differ diff --git a/.gitbook/assets/connecting-gcp-project-2-service-account.gif b/.gitbook/assets/connecting-gcp-project-2-service-account.gif new file mode 100644 index 0000000..0ffc9dd Binary files /dev/null and b/.gitbook/assets/connecting-gcp-project-2-service-account.gif differ diff --git a/.gitbook/assets/creating-threads-1-detailed-form.png b/.gitbook/assets/creating-threads-1-detailed-form.png new file mode 100644 index 0000000..5e344b2 Binary files /dev/null and b/.gitbook/assets/creating-threads-1-detailed-form.png differ diff --git a/.gitbook/assets/creating-threads-1-select-opportunities.png b/.gitbook/assets/creating-threads-1-select-opportunities.png new file mode 100644 index 0000000..3ed9a48 Binary files /dev/null and b/.gitbook/assets/creating-threads-1-select-opportunities.png differ diff --git a/.gitbook/assets/creating-threads-1-simple-form.png b/.gitbook/assets/creating-threads-1-simple-form.png new file mode 100644 index 0000000..a602b59 Binary files /dev/null and b/.gitbook/assets/creating-threads-1-simple-form.png differ diff --git a/.gitbook/assets/manual-opportunities-1-create.png b/.gitbook/assets/manual-opportunities-1-create.png new file mode 100644 index 0000000..32dae2f Binary files /dev/null and b/.gitbook/assets/manual-opportunities-1-create.png differ diff --git a/.gitbook/assets/onboarding_all_1.png b/.gitbook/assets/onboarding_all_1.png new file mode 100644 index 0000000..efec3f9 Binary files /dev/null and b/.gitbook/assets/onboarding_all_1.png differ diff --git a/.gitbook/assets/opportunities-explorer-1.png b/.gitbook/assets/opportunities-explorer-1.png new file mode 100644 index 0000000..4e03a8d Binary files /dev/null and b/.gitbook/assets/opportunities-explorer-1.png differ diff --git a/.gitbook/assets/optimizing-spend-1-explore-opportunities.png b/.gitbook/assets/optimizing-spend-1-explore-opportunities.png new file mode 100644 index 0000000..820fd2d Binary files /dev/null and b/.gitbook/assets/optimizing-spend-1-explore-opportunities.png differ diff --git a/.gitbook/assets/optimizing-spend-1-opportunities.png b/.gitbook/assets/optimizing-spend-1-opportunities.png new file mode 100644 index 0000000..8540ffa Binary files /dev/null and b/.gitbook/assets/optimizing-spend-1-opportunities.png differ diff --git a/.gitbook/assets/rule-library-1.png b/.gitbook/assets/rule-library-1.png new file mode 100644 index 0000000..18708d7 Binary files /dev/null and b/.gitbook/assets/rule-library-1.png differ diff --git a/.gitbook/assets/rules-lab-1.png b/.gitbook/assets/rules-lab-1.png new file mode 100644 index 0000000..df6b909 Binary files /dev/null and b/.gitbook/assets/rules-lab-1.png differ diff --git a/.gitbook/assets/savings-opportunity-2-rate-settings.png b/.gitbook/assets/savings-opportunity-2-rate-settings.png new file mode 100644 index 0000000..4a18927 Binary files /dev/null and b/.gitbook/assets/savings-opportunity-2-rate-settings.png differ diff --git a/.gitbook/assets/savings-report-1.gif b/.gitbook/assets/savings-report-1.gif new file mode 100644 index 0000000..3b47f74 Binary files /dev/null and b/.gitbook/assets/savings-report-1.gif differ diff --git a/.gitbook/assets/setting-teams-1-settings.png b/.gitbook/assets/setting-teams-1-settings.png new file mode 100644 index 0000000..16e7b9c Binary files /dev/null and b/.gitbook/assets/setting-teams-1-settings.png differ diff --git a/.gitbook/assets/setting-teams-1-team-setup-2.png b/.gitbook/assets/setting-teams-1-team-setup-2.png new file mode 100644 index 0000000..bf199d2 Binary files /dev/null and b/.gitbook/assets/setting-teams-1-team-setup-2.png differ diff --git a/.gitbook/assets/setting-teams-1-team-setup.png b/.gitbook/assets/setting-teams-1-team-setup.png new file mode 100644 index 0000000..912c8cd Binary files /dev/null and b/.gitbook/assets/setting-teams-1-team-setup.png differ diff --git a/.gitbook/assets/settings-2-savings-opportunities-active.png b/.gitbook/assets/settings-2-savings-opportunities-active.png new file mode 100644 index 0000000..f9b432d Binary files /dev/null and b/.gitbook/assets/settings-2-savings-opportunities-active.png differ diff --git a/.gitbook/assets/settings-2-savings-opportunities-thresholds-2.png b/.gitbook/assets/settings-2-savings-opportunities-thresholds-2.png new file mode 100644 index 0000000..ee4f917 Binary files /dev/null and b/.gitbook/assets/settings-2-savings-opportunities-thresholds-2.png differ diff --git a/.gitbook/assets/settings-2-savings-opportunities-thresholds.png b/.gitbook/assets/settings-2-savings-opportunities-thresholds.png new file mode 100644 index 0000000..2e34481 Binary files /dev/null and b/.gitbook/assets/settings-2-savings-opportunities-thresholds.png differ diff --git a/.gitbook/assets/settings-2-savings-opportunities.png b/.gitbook/assets/settings-2-savings-opportunities.png new file mode 100644 index 0000000..4aa7c79 Binary files /dev/null and b/.gitbook/assets/settings-2-savings-opportunities.png differ diff --git a/.gitbook/assets/settings-integrations-1-jira-cloud-2.png b/.gitbook/assets/settings-integrations-1-jira-cloud-2.png new file mode 100644 index 0000000..35f6aed Binary files /dev/null and b/.gitbook/assets/settings-integrations-1-jira-cloud-2.png differ diff --git a/.gitbook/assets/settings-integrations-1-jira-cloud-3.png b/.gitbook/assets/settings-integrations-1-jira-cloud-3.png new file mode 100644 index 0000000..9ac847a Binary files /dev/null and b/.gitbook/assets/settings-integrations-1-jira-cloud-3.png differ diff --git a/.gitbook/assets/settings-integrations-1-jira-cloud.png b/.gitbook/assets/settings-integrations-1-jira-cloud.png new file mode 100644 index 0000000..2418e2e Binary files /dev/null and b/.gitbook/assets/settings-integrations-1-jira-cloud.png differ diff --git a/.gitbook/assets/settings-integrations-4-jira-webhook.png b/.gitbook/assets/settings-integrations-4-jira-webhook.png new file mode 100644 index 0000000..3918812 Binary files /dev/null and b/.gitbook/assets/settings-integrations-4-jira-webhook.png differ diff --git a/.gitbook/assets/settings-integrations-5-jira-webhook.png b/.gitbook/assets/settings-integrations-5-jira-webhook.png new file mode 100644 index 0000000..411a5eb Binary files /dev/null and b/.gitbook/assets/settings-integrations-5-jira-webhook.png differ diff --git a/.gitbook/assets/settings-integrations-6-jira-webhook.png b/.gitbook/assets/settings-integrations-6-jira-webhook.png new file mode 100644 index 0000000..ff2eb88 Binary files /dev/null and b/.gitbook/assets/settings-integrations-6-jira-webhook.png differ diff --git a/.gitbook/assets/settings-integrations-7-jira-webhook.png b/.gitbook/assets/settings-integrations-7-jira-webhook.png new file mode 100644 index 0000000..c9c50a2 Binary files /dev/null and b/.gitbook/assets/settings-integrations-7-jira-webhook.png differ diff --git a/.gitbook/assets/settings-integrations-8-jira-webhook.png b/.gitbook/assets/settings-integrations-8-jira-webhook.png new file mode 100644 index 0000000..92b93b6 Binary files /dev/null and b/.gitbook/assets/settings-integrations-8-jira-webhook.png differ diff --git a/.gitbook/assets/settings-integrations-9-jira-webhook.png b/.gitbook/assets/settings-integrations-9-jira-webhook.png new file mode 100644 index 0000000..7839bb7 Binary files /dev/null and b/.gitbook/assets/settings-integrations-9-jira-webhook.png differ diff --git a/.gitbook/assets/settings_sso_2.png b/.gitbook/assets/settings_sso_2.png new file mode 100644 index 0000000..913ab24 Binary files /dev/null and b/.gitbook/assets/settings_sso_2.png differ diff --git a/.gitbook/assets/settings_sso_3.png b/.gitbook/assets/settings_sso_3.png new file mode 100644 index 0000000..f47f513 Binary files /dev/null and b/.gitbook/assets/settings_sso_3.png differ diff --git a/.gitbook/assets/what-is-cloudthread-1-cost-lab-filter.png b/.gitbook/assets/what-is-cloudthread-1-cost-lab-filter.png new file mode 100644 index 0000000..d1d1dbb Binary files /dev/null and b/.gitbook/assets/what-is-cloudthread-1-cost-lab-filter.png differ diff --git a/.gitbook/assets/what-is-cloudthread-1-cost-lab.png b/.gitbook/assets/what-is-cloudthread-1-cost-lab.png new file mode 100644 index 0000000..4ffd6db Binary files /dev/null and b/.gitbook/assets/what-is-cloudthread-1-cost-lab.png differ diff --git a/.gitbook/assets/what-is-cloudthread-1-savings-hub.png b/.gitbook/assets/what-is-cloudthread-1-savings-hub.png new file mode 100644 index 0000000..0d56ee5 Binary files /dev/null and b/.gitbook/assets/what-is-cloudthread-1-savings-hub.png differ diff --git a/.gitbook/assets/what-is-cloudthread-1-tags.png b/.gitbook/assets/what-is-cloudthread-1-tags.png new file mode 100644 index 0000000..c6b97fd Binary files /dev/null and b/.gitbook/assets/what-is-cloudthread-1-tags.png differ diff --git a/.gitbook/assets/what-is-cloudthread-1-unit-metrics.png b/.gitbook/assets/what-is-cloudthread-1-unit-metrics.png new file mode 100644 index 0000000..6177b4a Binary files /dev/null and b/.gitbook/assets/what-is-cloudthread-1-unit-metrics.png differ diff --git a/README.md b/README.md index 950c032..a496a6b 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Whether you're just getting started with **Cloud Financial Management** or you'r {% tabs %} {% tab title="Cost Savings Insights" %} -

Cloudthread Cost Savings Insights

+

Cloudthread Cost Savings Insights

{% content-ref url="guides/optimizing-cloud-costs/creating-saving-threads.md" %} [creating-saving-threads.md](guides/optimizing-cloud-costs/creating-saving-threads.md) @@ -23,7 +23,7 @@ Whether you're just getting started with **Cloud Financial Management** or you'r {% endtab %} {% tab title="Cloud Cost Analytics" %} -

Cloudthread Cost Summary Dashboard

+

Cloudthread Cost Summary Dashboard

{% content-ref url="guides/monitoring-cloud-costs/creating-custom-dashboards.md" %} [creating-custom-dashboards.md](guides/monitoring-cloud-costs/creating-custom-dashboards.md) @@ -31,7 +31,7 @@ Whether you're just getting started with **Cloud Financial Management** or you'r {% endtab %} {% tab title="Root Cause Analysis" %} -

Cloudthread Cost Analytics Dashboard

+

Cloudthread Cost Analytics Dashboard

{% content-ref url="guides/monitoring-cloud-costs/performing-root-cause-analysis.md" %} [performing-root-cause-analysis.md](guides/monitoring-cloud-costs/performing-root-cause-analysis.md) @@ -39,7 +39,7 @@ Whether you're just getting started with **Cloud Financial Management** or you'r {% endtab %} {% tab title="Unit Metrics" %} -

Cloudthread Unit Metrics

+

Cloudthread Unit Metrics

{% content-ref url="guides/monitoring-cloud-costs/creating-custom-unit-metrics.md" %} [creating-custom-unit-metrics.md](guides/monitoring-cloud-costs/creating-custom-unit-metrics.md) @@ -47,7 +47,7 @@ Whether you're just getting started with **Cloud Financial Management** or you'r {% endtab %} {% tab title="Tag Assistant" %} -

Cloudthread Tag Assistant

+

Cloudthread Tag Assistant

{% content-ref url="guides/tagging-cloud-resources/setting-up-tag-catalog.md" %} [setting-up-tag-catalog.md](guides/tagging-cloud-resources/setting-up-tag-catalog.md) @@ -79,12 +79,18 @@ If you are just starting with cloud cost management (a.k.a. FinOps, Cloud Financ ## Starting takes just 10 min -You can get started with **advanced cloud cost management** within just **10 minutes**! [Create an account](https://app.core.cloudthread.io/sign-up) and refer to [connecting-aws-account.md](guides/onboarding/connecting-aws-account.md "mention") section for a fast onboarding experience. +You can get started with **advanced cloud cost management** within just **10 minutes**! [Create an account](https://app.core.cloudthread.io/sign-up) and refer to [onboarding](guides/onboarding/ "mention") section for a fast onboarding experience. -{% hint style="warning" %} -Cloudthread is supporting only **AWS** at the moment. **Google Cloud** integration is on the way. If you are using other cloud providers, please let us know [here](https://www.cloudthread.io/contact-us). +{% hint style="success" %} +Cloudthread supports **AWS** and **GCP** – you can find the set up steps for both provides in the sections below. {% endhint %} -## Support +{% content-ref url="guides/onboarding/connecting-aws-account.md" %} +[connecting-aws-account.md](guides/onboarding/connecting-aws-account.md) +{% endcontent-ref %} + +{% content-ref url="guides/onboarding/connecting-gcp-billing-account.md" %} +[connecting-gcp-billing-account.md](guides/onboarding/connecting-gcp-billing-account.md) +{% endcontent-ref %} If you ever need help setting things up or have feature requests, don't hesitate to reach out to us at [hey@cloudthread.io](mailto:hey@cloudthread.io) diff --git a/SUMMARY.md b/SUMMARY.md index 4ec541d..df92828 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -2,19 +2,19 @@ * [☁ What Is Cloudthread](README.md) * [πŸš€ Quick Start](quick-start.md) -* [🎁 AWS Save or Get Paid Eligibility and Onboarding Checklist](aws-save-or-get-paid-eligibility-and-onboarding-checklist.md) ## πŸ—Ί Guides * [Onboarding](guides/onboarding/README.md) * [Connecting AWS Management Account](guides/onboarding/connecting-aws-account.md) + * [Connecting GCP Billing Account](guides/onboarding/connecting-gcp-billing-account.md) * [Adding new Users](guides/onboarding/managing-account-and-team-1.md) * [Setting up Teams](guides/onboarding/setting-up-teams.md) * [Optimizing Cloud Costs](guides/optimizing-cloud-costs/README.md) - * [Analyzing Optimization Opportunities](guides/optimizing-cloud-costs/analyzing-optimization-opportunities.md) + * [Analyzing Savings Opportunities](guides/optimizing-cloud-costs/analyzing-optimization-opportunities.md) * [Creating Saving Threads](guides/optimizing-cloud-costs/creating-saving-threads.md) - * [Creating Custom Optimization Opportunities](guides/optimizing-cloud-costs/creating-custom-optimization-opportunities.md) - * [Supported Optimization Opportunities](guides/optimizing-cloud-costs/supported-optimization-opportunities.md) + * [Creating Manual Savings Opportunities](guides/optimizing-cloud-costs/creating-custom-optimization-opportunities.md) + * [Supported Savings Opportunities](guides/optimizing-cloud-costs/supported-savings-opportunities.md) * [Monitoring Cloud Costs](guides/monitoring-cloud-costs/README.md) * [Creating Cost Views](guides/monitoring-cloud-costs/creating-custom-cost-views.md) * [Creating Unit Metrics](guides/monitoring-cloud-costs/creating-custom-unit-metrics.md) @@ -33,10 +33,10 @@ * [Cost Savings](fundamentals/cost-savings/README.md) * [Key Concepts](fundamentals/cost-savings/key-concepts/README.md) - * [Optimization Opportunities](fundamentals/cost-savings/key-concepts/optimization-opportunities.md) + * [Savings Opportunities](fundamentals/cost-savings/key-concepts/optimization-opportunities.md) * [Savings Threads](fundamentals/cost-savings/key-concepts/savings-threads.md) * [Savings Dashboard](fundamentals/cost-savings/savings-dashboard.md) - * [Savings Threads \[App Section\]](fundamentals/cost-savings/savings-threads-app-section.md) + * [Savings Threads Section](fundamentals/cost-savings/savings-threads-app-section.md) * [Opportunities Explorer](fundamentals/cost-savings/opportunities-explorer.md) * [Custom Dashboards](fundamentals/dashboards/README.md) * [Summary Dashboard](fundamentals/dashboards/summary-dashboard.md) @@ -56,8 +56,8 @@ * [Cost Allocation Rules](fundamentals/cost-transparency/key-concepts/cost-allocation-rules.md) * [Costs Overview](fundamentals/cost-transparency/costs-overview.md) * [Cost View Library](fundamentals/cost-transparency/cost-view-library.md) - * [Rule Editor](fundamentals/cost-transparency/rule-editor.md) - * [Rules Library](fundamentals/cost-transparency/rules-library.md) + * [Rule Lab](fundamentals/cost-transparency/rule-editor.md) + * [Rule Library](fundamentals/cost-transparency/rules-library.md) * [Unit Economics](fundamentals/unit-metrics/README.md) * [Key Concepts](fundamentals/unit-metrics/key-concepts/README.md) * [Unit Metrics](fundamentals/unit-metrics/key-concepts/unit-metric.md) @@ -71,8 +71,9 @@ * [Reports](fundamentals/notifications/reports.md) * [Settings](fundamentals/settings/README.md) * [Profile](fundamentals/settings/user-profile.md) + * [Savings Opportunities Settings](fundamentals/settings/savings-opportunities-settings.md) * [User Management](fundamentals/settings/account-and-team-management.md) - * [Integrations](fundamentals/settings/slack-integration.md) + * [Integrations](fundamentals/settings/integrations.md) * [SSO](fundamentals/settings/sso.md) * [Payment](fundamentals/settings/payment.md) * [Pull Data Collection](fundamentals/settings/data-collection.md) diff --git a/aws-save-or-get-paid-eligibility-and-onboarding-checklist.md b/aws-save-or-get-paid-eligibility-and-onboarding-checklist.md deleted file mode 100644 index 4857e55..0000000 --- a/aws-save-or-get-paid-eligibility-and-onboarding-checklist.md +++ /dev/null @@ -1,18 +0,0 @@ -# 🎁 AWS Save or Get Paid Eligibility and Onboarding Checklist - -## Eligibility - -* Must be spending over **$5,000 / mo** on AWS and not using credits -* Must complete [#full-cloudthread-onboarding](aws-save-or-get-paid-eligibility-and-onboarding-checklist.md#full-cloudthread-onboarding "mention") as defined below -* Must onboard before **May 31st, 2023** - -## Full Cloudthread Onboarding - -{% hint style="info" %} -See details on connecting your AWS accounts in [connecting-aws-account.md](guides/onboarding/connecting-aws-account.md "mention") guide. -{% endhint %} - -* Create a Cloudthread Account -* [Integrate](guides/onboarding/connecting-aws-account.md) Cloudthread with all your AWS accounts -* Turn on Compute Optimizer ([here](https://console.aws.amazon.com/compute-optimizer)) -* Turn on Cost Explorer Recommendations ([here](https://console.aws.amazon.com/cost-management/home#/settings)) diff --git a/fundamentals/cost-savings/key-concepts/optimization-opportunities.md b/fundamentals/cost-savings/key-concepts/optimization-opportunities.md index 7e9740c..a57eb63 100644 --- a/fundamentals/cost-savings/key-concepts/optimization-opportunities.md +++ b/fundamentals/cost-savings/key-concepts/optimization-opportunities.md @@ -1,4 +1,4 @@ -# Optimization Opportunities +# Savings Opportunities **Optimization Opportunity** is a concrete **recommendation** on the **cost optimization action** for a **specific** cloud **resource** (or group of resources for Rate Optimization). @@ -29,11 +29,11 @@ Optimization **type** defines the nature of the cost savings recommendation. Dif {% hint style="info" %} Cloudthread currently supports **3 major types** of Optimization Opportunities: -**Usage** Opportunities +**Usage Optimization** Opportunities * Actions altering actual cloud resources (e.g. changing VM specs, storage retention policies, removing unused resources) -**Rate** Opportunities +**Rate Optimization** Opportunities * Actions targeting financial concepts, mainly commitment-based discounts (e.g. [Reserved Instances](https://aws.amazon.com/ec2/pricing/reserved-instances/) and [Savings Plans](https://aws.amazon.com/savingsplans/) for AWS, [Committed Use Discounts](https://cloud.google.com/compute/docs/instances/signing-up-committed-use-discounts) for GCP) @@ -42,6 +42,41 @@ Cloudthread currently supports **3 major types** of Optimization Opportunities: * Ad-hoc opportunities for custom tracking needs. See [creating-custom-optimization-opportunities.md](../../../guides/optimizing-cloud-costs/creating-custom-optimization-opportunities.md "mention") for more details. {% endhint %} +#### Rate Optimization settings + +Rate optimization opportunities can be set up for a desired configuration of cloud commitments. + +
+ +
+ +
+ +The settings window can be opened by clicking `Rate Optimization Settings` button at the top right corner of [opportunities-explorer.md](../opportunities-explorer.md "mention") section. + +{% hint style="info" %} +Currently the settings of AWS [Reserved Instances](https://aws.amazon.com/ec2/pricing/reserved-instances/) and [Savings Plans](https://aws.amazon.com/savingsplans/) can be adjusted. +{% endhint %} + +These are the attributes of AWS [Reserved Instances](https://aws.amazon.com/ec2/pricing/reserved-instances/) and [Savings Plans](https://aws.amazon.com/savingsplans/) hat can be changed: + +* Reserved Instances + * Term: 1 year or 3 years + * Payment: No Upfront, Partial Upfront, All Upfront + * EC2 Offering Class +* Savings Plans + * Term: 1 year or 3 years + * Payment: No Upfront, Partial Upfront, All Upfront + * Lookback + +#### Usage Optimization settings + +See [savings-opportunities-settings.md](../../settings/savings-opportunities-settings.md "mention") for more details. + +{% content-ref url="../../settings/savings-opportunities-settings.md" %} +[savings-opportunities-settings.md](../../settings/savings-opportunities-settings.md) +{% endcontent-ref %} + #### Estimated savings An estimated financial impact of acting on opportunity recommendation. Can be Daily, Monthly, Quarterly and Yearly. @@ -123,6 +158,10 @@ Code snippets or automation setup. * **Code snippets for CLI** * **Opt-in automation if applicable** +## Savings Opportunities Settings + +Savings Opportunities detection criteria can be adjusted in [settings](../../settings/ "mention"). + ## Supported Opportunities {% hint style="success" %} diff --git a/fundamentals/cost-savings/opportunities-explorer.md b/fundamentals/cost-savings/opportunities-explorer.md index 882fe29..5d96137 100644 --- a/fundamentals/cost-savings/opportunities-explorer.md +++ b/fundamentals/cost-savings/opportunities-explorer.md @@ -6,17 +6,58 @@ description: App Section **Opportunities Explorer** is the section of the app where you can manage [optimization-opportunities.md](key-concepts/optimization-opportunities.md "mention"). -

Cloudthread Opportunities Explorer

+

Cloudthread Opportunities Explorer

## Key Features -### Create New Opportunity Button +### New Manual Opportunity Button Cloudthread allows for creation of custom optimization opportunities. This button starts the creation flow. Refer to [creating-custom-optimization-opportunities.md](../../guides/optimizing-cloud-costs/creating-custom-optimization-opportunities.md "mention") for more details. -### Unassigned Opportunities Table +### Teams Dropdown -List of all discovered and custom opportunities that were not assigned to any thread: +Allows to choose a [teams.md](../settings/teams.md "mention"). See [setting-up-teams.md](../../guides/onboarding/setting-up-teams.md "mention") for more information. + +### Platform Selector + +Filters [#opportunities-table](opportunities-explorer.md#opportunities-table "mention") for the cloud provider. + +{% hint style="info" %} +Currently Cloudthread platform supports **AWS** and **GCP**. +{% endhint %} + +### Rate Optimization Settings + +Rate optimization opportunities can be set up for a desired configuration of cloud commitments. + +
+ +
+ +
+ +The settings window can be opened by clicking `Rate Optimization Settings` button at the top right corner of [opportunities-explorer.md](opportunities-explorer.md "mention") section. + +{% hint style="info" %} +Currently the settings of AWS [Reserved Instances](https://aws.amazon.com/ec2/pricing/reserved-instances/) and [Savings Plans](https://aws.amazon.com/savingsplans/) can be adjusted. +{% endhint %} + +These are the attributes of AWS [Reserved Instances](https://aws.amazon.com/ec2/pricing/reserved-instances/) and [Savings Plans](https://aws.amazon.com/savingsplans/) hat can be changed: + +* Reserved Instances + * Term: 1 year or 3 years + * Payment: No Upfront, Partial Upfront, All Upfront + * EC2 Offering Class +* Savings Plans + * Term: 1 year or 3 years + * Payment: No Upfront, Partial Upfront, All Upfront + * Lookback + +### Opportunities Table + +List of all discovered and custom opportunities. + +Table fields: * Opportunity ID * Record ID @@ -54,17 +95,11 @@ Redirects to a form for adding opportunities to an existing Thread (see [savings #### Archive Selected Button -Moves selected opportunities to [#archived-opportunities-table](opportunities-explorer.md#archived-opportunities-table "mention"). This functionality allows to **ignore** the opportunities that are **irrelevant** and will not be implemented. +Archives selected opportunities. This functionality allows to **ignore** the opportunities that are **irrelevant** and will not be implemented. {% hint style="info" %} Opportunities can be **archived** by clicking trash bin button in Actions column at the end of the table. -{% endhint %} - -### Archived Opportunities Table -The table with matching structure tot he above containing archived opportunities. - -{% hint style="info" %} Archived opportunities can be **restored** by clicking restore button in Actions column at the end of the table. {% endhint %} diff --git a/fundamentals/cost-transparency/key-concepts/events-overlay.md b/fundamentals/cost-transparency/key-concepts/events-overlay.md index 761a85f..2b6c4b9 100644 --- a/fundamentals/cost-transparency/key-concepts/events-overlay.md +++ b/fundamentals/cost-transparency/key-concepts/events-overlay.md @@ -2,6 +2,6 @@ **Events Overlay** allows to display historical events on [#absolute-cost-chart](../costs-overview.md#absolute-cost-chart "mention") in [costs-overview.md](../costs-overview.md "mention") section for [cost-view.md](cost-view.md "mention"). -The events data gets uploaded to the platform through an [API](http://localhost:5000/o/TmVItW5TwUC23RxcuDg9/s/KuhDuXL0YPX22VMOHZWV/ "mention") in a time series format, following [ingesting-custom-data.md](../../../guides/monitoring-cloud-costs/ingesting-custom-data.md "mention") process. +The events data gets uploaded to the platform through an [API](http://127.0.0.1:5000/o/TmVItW5TwUC23RxcuDg9/s/KuhDuXL0YPX22VMOHZWV/ "mention") in a time series format, following [ingesting-custom-data.md](../../../guides/monitoring-cloud-costs/ingesting-custom-data.md "mention") process.

Events Overlay

diff --git a/fundamentals/cost-transparency/rule-editor.md b/fundamentals/cost-transparency/rule-editor.md index 84b0d29..f63f792 100644 --- a/fundamentals/cost-transparency/rule-editor.md +++ b/fundamentals/cost-transparency/rule-editor.md @@ -2,15 +2,15 @@ description: App Section --- -# Rule Editor +# Rule Lab -**Rule Editor** is the section of the app where you can define [cost-allocation-rules.md](key-concepts/cost-allocation-rules.md "mention"). +**Rule Lab** is the section of the app where you can define [cost-allocation-rules.md](key-concepts/cost-allocation-rules.md "mention"). -

Cloudthread Rule Editor

+

Cloudthread Rule Lab

## Key Features -### Rule Editor Control Pane +### Rule Lab Control Pane
@@ -44,7 +44,7 @@ Needed for showing the total cost per rule. ### Tags Summary Pane -This pane summarizes all Custom Tags you have created in Rules Editor. +This pane summarizes all Custom Tags you have created in Rule Lab.
@@ -56,7 +56,7 @@ This pane summarizes all Custom Tags you have created in Rules Editor. The button saves the costs distributed by tags (by cost allocation rules) in CSV format. -### Rule Editor Interface +### Rule Lab Interface This is the interface for creating and editing the [cost-allocation-rules.md](key-concepts/cost-allocation-rules.md "mention"). diff --git a/fundamentals/cost-transparency/rules-library.md b/fundamentals/cost-transparency/rules-library.md index 138408f..d8c8766 100644 --- a/fundamentals/cost-transparency/rules-library.md +++ b/fundamentals/cost-transparency/rules-library.md @@ -2,8 +2,8 @@ description: App Section --- -# Rules Library +# Rule Library -**Rules Library** is the section of the app where you can see and manage all saved [cost-allocation-rules.md](key-concepts/cost-allocation-rules.md "mention"). +**Rule Library** is the section of the app where you can see and manage all saved [cost-allocation-rules.md](key-concepts/cost-allocation-rules.md "mention"). -

Cloudthread Rules Library

+

Cloudthread Rules Library

diff --git a/fundamentals/custom-data-api.md b/fundamentals/custom-data-api.md index 141a3b7..b433df2 100644 --- a/fundamentals/custom-data-api.md +++ b/fundamentals/custom-data-api.md @@ -1,3 +1,3 @@ # Custom Data API -See [API](http://localhost:5000/o/TmVItW5TwUC23RxcuDg9/s/KuhDuXL0YPX22VMOHZWV/ "mention") for detailed infromation. +See [API](http://127.0.0.1:5000/o/TmVItW5TwUC23RxcuDg9/s/KuhDuXL0YPX22VMOHZWV/ "mention") for detailed infromation. diff --git a/fundamentals/notifications/reports.md b/fundamentals/notifications/reports.md index 4676253..82021ce 100644 --- a/fundamentals/notifications/reports.md +++ b/fundamentals/notifications/reports.md @@ -3,22 +3,42 @@ **Reports** are detailed notifications sent on schedule. {% hint style="info" %} -Cloudthread supports **e-mail** and **Slack** reports. See [setting-up-alerts-and-reports.md](../../guides/monitoring-cloud-costs/setting-up-alerts-and-reports.md "mention") for setup instructions. +Cloudthread supports the delivery of reports through **e-mail** and **Slack**. See [setting-up-alerts-and-reports.md](../../guides/monitoring-cloud-costs/setting-up-alerts-and-reports.md "mention") for setup instructions. {% endhint %} {% hint style="success" %} Cloudthread supports 3 types of Reports: -* **Daily** -* **Weekly** -* **Movers & Shakers** - * This report is a type of anomaly detection implemented on Cloudthread platform: it is being sent only in case there are significant changes in cost detected within the whole AWS environment +* **Daily Cost Update** +* **Weekly Cost Report** + * **Movers & Shakers Section** + * This report is a type of anomaly detection implemented on Cloudthread platform: it is being sent only in case there are significant changes in cost detected within the whole AWS environment +* **Weekly Savings Report** + * Report on [optimization-opportunities.md](../cost-savings/key-concepts/optimization-opportunities.md "mention") {% endhint %} -### Email Reports +{% hint style="info" %} +Movers & Shakers is the version of **anomaly detection** Cloudthread platform supports. +{% endhint %} + +## **Cost** Reports + +### Email

Cloudthread Email Weekly Cost Report

-### Slack Reports +### Slack

Cloudthread Slack Weekly Cost Report

+ +## Savings Report + +Savings report is part of [cost-savings](../cost-savings/ "mention") functionality. It is generated on a weekly basis and brings up the [optimization-opportunities.md](../cost-savings/key-concepts/optimization-opportunities.md "mention") discovered during the week. + +The report has 3 parts: + +* Total savings statistics +* Workflows summary: [savings-threads.md](../cost-savings/key-concepts/savings-threads.md "mention") +* Top 5 opportunities + +

Cloudthread Savings Report

diff --git a/fundamentals/settings/data-collection.md b/fundamentals/settings/data-collection.md index 237d9e2..52c0f57 100644 --- a/fundamentals/settings/data-collection.md +++ b/fundamentals/settings/data-collection.md @@ -25,12 +25,14 @@ You can generate these templates in the Settings > Data Collection part of the p ### New Cost and Usage report -This stack template is for companies who do not already have a Cost and Usage report that matches Cloudthread's requirements. This template should be run in your main account if you're not using AWS Organizations, or in your organization root account if you are using AWS Organizations. +This stack template is for companies who do not already have a Cost and Usage report that matches Cloudthread's requirements. This template should be run in your main account if you're not using AWS Organizations, or in your organization root account if you are using AWS Organizations. If you're using AWS Organizations your organization Root ID will be required. -### Master Account templates with an Existing Cost and Usage Report +### Existing Cost and Usage Report This stack template is for companies who have an existing Cost and Usage report that matches Cloudthread's requirements. You will be required to submit your report name, report prefix, and report bucket in the creation form. This template should be run in your main account if you're not using AWS Organizations, or in your organization root account if you are using AWS Organizations. If you're using AWS Organizations your organization Root ID will be required. +Exact permissions can be found in [Cloudthread Policy](../../policy\_cfn\_cldthrd.yaml) + ## Kubernetes Cloudthread's K8s integration is Helm Chart based. diff --git a/fundamentals/settings/integrations.md b/fundamentals/settings/integrations.md new file mode 100644 index 0000000..ad7f470 --- /dev/null +++ b/fundamentals/settings/integrations.md @@ -0,0 +1,142 @@ +# Integrations + +**Integrations** section of [.](./ "mention") has **Slack** and **Jira** integrations available. + +
+ +
+ +
+ +## Slack Integration + +In order to setup **Slack** for [alerts.md](../notifications/alerts.md "mention") and [reports.md](../notifications/reports.md "mention") you need to navigate to **Settings** menu item at the bottom part of the menu to the left, choose **Integrations** section and click Slack button. + +After that you will be redirected to the Slack setup page. + +
+ +Slack setup screen + +
+ +Once you have Slack setup, you will have your workspace channels available in [setting-up-alerts-and-reports.md](../../guides/monitoring-cloud-costs/setting-up-alerts-and-reports.md "mention"). + +## Jira Integration + +In order to use [savings-threads.md](../cost-savings/key-concepts/savings-threads.md "mention") workflow functionality, you need to set up Jira **integration.** + +{% hint style="success" %} +Cloudthread currently supports only [Jira project management](https://www.atlassian.com/software/jira) integration. Both **Cloud** and **Server** versions are supported. +{% endhint %} + +### Jira Cloud + +![](../../.gitbook/assets/settings-integrations-1-jira-cloud.png) + +#### Detailed instructions + +1. Once you click `Integrate` in Integrations section of Settings, you will be redirected to Atlassian sign-in +2. Sign in or create an account for JIRA cloud +3. Accept access request + +
+ +
+ +
+4. Come back to Cloudthread app to verify that integration is successful + +
+ +
+ +
+ +### Jira Server + +
+ +
+ +
+ +The following instructions are for version 9.11 in the Application Link in official [Jira documentation](https://app.cloudthread.io/settings/third-party-integrations?provider=jira\_server). + +For older versions, please follow the Jira documentation. + +#### Detailed instructions + +1. Go to Jira Administration > Applications > Application Links +2. Click `Create Link` and select `External application` + `Direction Incoming` +3. For Name - set to whatever they want (`Cloudthread` is fine) +4. For Redirect URL - set to [`https://app.cloudthread.io/settings/third-party-integrations?provider=jira_server`](https://app.cloudthread.io/settings/third-party-integrations?provider=jira\_server) +5. For Application permissions - set to `Write` +6. Click `Save` +7. Go to Cloudthread and Settings >Integrations and click `JIRA Server` +8. Enter: +9. Client ID from step 6 +10. Client Secret from step 6 +11. Jira server url including https:// and no trailing slash (e.g. [`https://mycompany.atlassian.server.com`](https://mycompany.atlassian.server.com/)) +12. Follow through integration flow + +### Jira Webhook + +{% hint style="info" %} +Some helpful information about adding a new webhook you can find in official [Jira documentation](https://developer.atlassian.com/cloud/jira/platform/webhooks/). +{% endhint %} + +#### Detailed Instructions for Jira Cloud + +1. In Jira go into Settings β†’ System + +
+ +
+ +
+2. In Jira go into Advanced β†’ Webhooks + + + +
+ +
+ +
+3. Click on Create a `WebHooks` button + + + +
+ +
+ +
+4. Copy webhook URL from Cloudthread β†’ Settings β†’ Integrations β†’ JIRA Webhook URL + + + +
+ +
+ +
+5. Put Cloudthread WebHook URL into URL field in `Create a WebHook` UI in Jira cloud + + + +
+ +
+ +
+6. Select β€˜updated’ and β€˜deleted’ events for Jira issues. You are allowed to write a specific JQL query for the related project to reduce the amount of events that are sent to Cloudthread + + + +
+ +
+ +
diff --git a/fundamentals/settings/savings-opportunities-settings.md b/fundamentals/settings/savings-opportunities-settings.md new file mode 100644 index 0000000..d55fe52 --- /dev/null +++ b/fundamentals/settings/savings-opportunities-settings.md @@ -0,0 +1,41 @@ +# Savings Opportunities Settings + +This is the section of [.](./ "mention") that allows to modify [optimization-opportunities.md](../cost-savings/key-concepts/optimization-opportunities.md "mention") detection criteria. + +
+ +
+ +
+ +{% hint style="success" %} +Opportunity settings can be defined for **all** the accounts or for the **specific** accounts. +{% endhint %} + +## Savings Opportunities settings types + +All [optimization-opportunities.md](../cost-savings/key-concepts/optimization-opportunities.md "mention") have the **On/Off** setting, i.e. you can mange if certain opportunities are being detected for the specific accounts (or all the accounts). + +
+ +
+ +
+ +For some opportunities there are additional settings available. These are mainly opportunities of **Usage type** (see [#optimization-type](../cost-savings/key-concepts/optimization-opportunities.md#optimization-type "mention") for more context). Examples of the adjustable threshold settings include: + +* % CPU utilization +* Number of lookback days for analysis +* % of freeable Memory + +
+ +
+ +
+ +
+ +
+ +
diff --git a/fundamentals/settings/slack-integration.md b/fundamentals/settings/slack-integration.md deleted file mode 100644 index 93c1b0d..0000000 --- a/fundamentals/settings/slack-integration.md +++ /dev/null @@ -1,48 +0,0 @@ -# Integrations - -**Integrations** section of [.](./ "mention") has **Slack** and **Jira** integrations available. - -
- -## Slack Integration - -In order to setup **Slack** for [alerts.md](../notifications/alerts.md "mention") and [reports.md](../notifications/reports.md "mention") you need to navigate to **Settings** menu item at the bottom part of the menu to the left, choose **Integrations** section and click Slack button. - -After that you will be redirected to the Slack setup page. - -![Slack setup screen](<../../.gitbook/assets/image (11).png>) - -Once you have Slack setup, you will have your workspace channels available in [setting-up-alerts-and-reports.md](../../guides/monitoring-cloud-costs/setting-up-alerts-and-reports.md "mention"). - -## Jira Integration - -In order to use [savings-threads.md](../cost-savings/key-concepts/savings-threads.md "mention") workflow functionality, you need to set up Jira **integration.** - -{% hint style="success" %} -Cloudthread currently supports only [Jira project management](https://www.atlassian.com/software/jira) integration. Both **Cloud** and **Server** versions are supported. -{% endhint %} - -### Jira Cloud - -### Jira Server - -
- -
- -
- -#### Detailed instructions - -1. Go to Jira Administration > Applications > Application Links -2. Click `Create Link` and select `External application` + `Direction Incoming` -3. For Name - set to whatever they want (`Cloudthread` is fine) -4. For Redirect URL - set to [`https://app.cloudthread.io/settings/third-party-integrations?provider=jira_server`](https://app.cloudthread.io/settings/third-party-integrations?provider=jira\_server) -5. For Application permissions - set to `Write` -6. Click `Save` -7. Go to Cloudthread and Settings >Integrations and click `JIRA Server` -8. Enter: -9. Client ID from step 6 -10. Client Secret from step 6 -11. Jira server url including https:// and no trailing slash (e.g. [`https://mycompany.atlassian.server.com`](https://mycompany.atlassian.server.com/)) -12. Follow through integration flow diff --git a/fundamentals/settings/sso.md b/fundamentals/settings/sso.md index 7b60d4b..90559d9 100644 --- a/fundamentals/settings/sso.md +++ b/fundamentals/settings/sso.md @@ -2,4 +2,26 @@ Cloudthread supports **Single Sign On** functionality for Enterprise users. -
+{% hint style="info" %} +[WorkOS Single Sign-On](https://workos.com/docs/sso) is used to enable SSO functionality. It supports all major SSO providers and allows for easy integration. +{% endhint %} + +To enable SSO for your organisation, follow these steps: + +1. Go to Settings -> SSO +2. Add allowed domain and click `+` and then `Update Settings` + + * If you want to allow domains outside the allowed list, make sure to turn on the `Allow profiles outside allowed domains` toggle + + + +
+3. Click `Set Up Connection` – you will be redirected to WorkOS interface + + * Choose the SSO provider you use and follow the instructions + + + +
+4. Change your org slug in [user-profile.md](user-profile.md "mention") section if needed + diff --git a/fundamentals/settings/user-profile.md b/fundamentals/settings/user-profile.md index ab003b4..c0c8ea4 100644 --- a/fundamentals/settings/user-profile.md +++ b/fundamentals/settings/user-profile.md @@ -2,8 +2,12 @@ This is the section of [.](./ "mention") that allows to modify **User Profile** information. +
+
+
+ ## Changeable profile features * User Name diff --git a/guides/monitoring-cloud-costs/ingesting-custom-data-1.md b/guides/monitoring-cloud-costs/ingesting-custom-data-1.md index 87eeae0..280a421 100644 --- a/guides/monitoring-cloud-costs/ingesting-custom-data-1.md +++ b/guides/monitoring-cloud-costs/ingesting-custom-data-1.md @@ -15,7 +15,7 @@ Adding an Events Overlay to your absolute cloud cost chart allows to: [events-overlay.md](../../fundamentals/cost-transparency/key-concepts/events-overlay.md "mention") relies on [custom-data-api.md](../../fundamentals/custom-data-api.md "mention") for the events data upload. Below are the instructions: -1. Please, refer to the [API](http://localhost:5000/o/TmVItW5TwUC23RxcuDg9/s/KuhDuXL0YPX22VMOHZWV/ "mention") documentation for detailed instructions on how to setup a data stream +1. Please, refer to the [API](http://127.0.0.1:5000/o/TmVItW5TwUC23RxcuDg9/s/KuhDuXL0YPX22VMOHZWV/ "mention") documentation for detailed instructions on how to setup a data stream 2. Once you have set up the data stream, you will be able to use the **events data stream objects** 3. Go to the [costs-overview.md](../../fundamentals/cost-transparency/costs-overview.md "mention") and click on the "Events" checkbox at the top of [#absolute-cost-chart](../../fundamentals/cost-transparency/costs-overview.md#absolute-cost-chart "mention") 4. See the events presented in form of blue vertical lines on the chart diff --git a/guides/monitoring-cloud-costs/ingesting-custom-data.md b/guides/monitoring-cloud-costs/ingesting-custom-data.md index cd3e970..c5bb093 100644 --- a/guides/monitoring-cloud-costs/ingesting-custom-data.md +++ b/guides/monitoring-cloud-costs/ingesting-custom-data.md @@ -13,5 +13,5 @@ Adding a custom data integration allows to: ## Detailed instructions -1. Please, refer to the [API](http://localhost:5000/o/TmVItW5TwUC23RxcuDg9/s/KuhDuXL0YPX22VMOHZWV/ "mention") documentation for detailed instructions on how to setup a data stream +1. Please, refer to the [API](http://127.0.0.1:5000/o/TmVItW5TwUC23RxcuDg9/s/KuhDuXL0YPX22VMOHZWV/ "mention") documentation for detailed instructions on how to setup a data stream 2. Once you have set up the data stream, you will be able to see the **custom data stream token** in the [#settings-pane](../../fundamentals/unit-metrics/unit-metrics-lab.md#settings-pane "mention") of [unit-metrics-lab.md](../../fundamentals/unit-metrics/unit-metrics-lab.md "mention") (under Custom data source) diff --git a/guides/onboarding/README.md b/guides/onboarding/README.md index 64715cb..24d70e0 100644 --- a/guides/onboarding/README.md +++ b/guides/onboarding/README.md @@ -10,9 +10,9 @@ Cloudthread is supporting only **AWS** at the moment. **Google Cloud** integrati After your account is [created](https://app.core.cloudthread.io/sign-up/) and confirmed via email, you'll be prompted to get connected to your cloud environment. The account creation process is quite standard and requires you to sign-up with email, Google or GitHub. -
+
-
+
@@ -20,7 +20,7 @@ After your account is [created](https://app.core.cloudthread.io/sign-up/) and co Connecting cloud environments is essential for Cloudthread to deliver insights and automation. Further in this guide you will find detailed instructions on how to set up AWS and GCP connections. -
+
### AWS @@ -28,10 +28,8 @@ Connecting cloud environments is essential for Cloudthread to deliver insights a [connecting-aws-account.md](connecting-aws-account.md) {% endcontent-ref %} -{% content-ref url="broken-reference" %} -[Broken link](broken-reference) -{% endcontent-ref %} - ### GCP -Coming soon. +{% content-ref url="connecting-gcp-billing-account.md" %} +[connecting-gcp-billing-account.md](connecting-gcp-billing-account.md) +{% endcontent-ref %} diff --git a/guides/onboarding/connecting-aws-account.md b/guides/onboarding/connecting-aws-account.md index 7654f20..61592be 100644 --- a/guides/onboarding/connecting-aws-account.md +++ b/guides/onboarding/connecting-aws-account.md @@ -1,8 +1,8 @@ # Connecting AWS Management Account -Connecting AWS account is an **essential** part of Cloudthread onboarding process and the most fundamental part of the setup. You cannot skip this step – your organization's AWS **savings, billing, and usage data** is essential for the platform to deliver value, i.e. help you to increase efficiency of your cloud spend. +Connecting cloud account is an **essential** part of Cloudthread onboarding process and the most fundamental part of the setup. You cannot skip this step – your organization's cloud **savings, billing, and usage data** is essential for the platform to deliver value, i.e. help you to increase efficiency of your cloud spend. -This is the guide for the **initial and essential** data access setup, which is aimed at **AWS** **Management** **Account** (see [AWS Consolidate Billing](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/consolidated-billing.html) for more information). This setup fully covers: +This is the guide for the **initial** data access setup, which is aimed at **AWS** **Management** **Account** (see [AWS Consolidate Billing](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/consolidated-billing.html) for more information). This setup fully covers: * **Billing data (CUR)** * **Savings Opportunity data** @@ -24,7 +24,7 @@ Cloudthread is using a delegated access role to read data from your account into * To read saved CUR files * AWS Services (EC2, RDS, ElastiCache, OpenSearch, etc.) * To generate usage optimization recommendations -* [AWS Trusted Advisor](http://localhost:5000/s/Q8QqeF6WFPo2rNkc3ND6/the-basics/collections) (if enabled) +* [AWS Trusted Advisor](http://127.0.0.1:5000/s/Q8QqeF6WFPo2rNkc3ND6/the-basics/collections) (if enabled) * To gather cost optimization recommendations suggested by AWS * [AWS Compute Optimizer](https://docs.aws.amazon.com/compute-optimizer/latest/ug/what-is-compute-optimizer.html) * To gather compute optimization recommendations suggested by AWS @@ -33,7 +33,7 @@ Cloudthread is using a delegated access role to read data from your account into In more detail, Cloudthread needs roughly **5 sets** of permissions / actions: 1. **CUR bucket creation**, with complete access to this bucket (and only this bucket). This allows us to maintain the bucket policy overtime for any AWS changes that are required to maintain the CUR connection, and read CUR data. -2. **Describe account read access** to understand AWS Organizations structure. +2. **Describe account read access** to understand AWS Organizations structure and gather account names and tags. 3. **Cost Explorer read access** to power the first 24 hours of the tool. 4. **CloudWatch read access** to collect CloudWatch data for savings opportunity processing. 5. **Savings polices with service read access**, to detect the savings opportunities. @@ -57,13 +57,25 @@ In order for Cloudthread start functioning and delivering value, AWS Management After your account is [created](https://app.core.cloudthread.io/sign-up/) and confirmed via email, you'll be prompted to get connected to your cloud environment through either creating a new Cost and Usage Report (CUR) or using the existing one. -

Connect Cloudthread via AWS CF Stack

+### 2. Choose an AWS integration option -### 2. Choose an integration option +On the cloud environment integration page you open up the **AWS** dropdown. -#### a. You do not have any existing Cost and Usage Report (or want to use a new one) +
-
+You will see the detailed instructions and a choice of AWS integration options covering most common situations: + +[#a.-you-do-not-have-any-existing-cost-and-usage-report-or-want-to-use-a-new-one](connecting-aws-account.md#a.-you-do-not-have-any-existing-cost-and-usage-report-or-want-to-use-a-new-one "mention") + +* a.1. You have only one account to integrate +* a.2. You have many accounts managed by [AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs\_introduction.html) + +[#b.-you-have-an-existing-cost-and-usage-report-set-up-and-want-to-use-it](connecting-aws-account.md#b.-you-have-an-existing-cost-and-usage-report-set-up-and-want-to-use-it "mention") + +* b.1. You have only one account to integrate +* b.2. You have many accounts managed by [AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs\_introduction.html) + +#### A. You do not have any existing Cost and Usage Report (or want to use a new one) Choose this option if: @@ -75,28 +87,55 @@ Choose this option if: * **Resource ID** level * You **have** Cost and Usage Report set up with settings above for your AWS billing account, but do not want to use it for some reason -**a.1. You have only one account to integrate** +**A.1. You have only one account to integrate** + +If you have only one account to integrate, choose the relevant option in the integration options menu. + +
+ +
+ +
+ +Click `Go to New Report Template` to get redirected to your AWS console with ClouFormation settings already prefilled for you. + +
+ +
-
+
-
+{% hint style="warning" %} +Make sure to log into the **AWS account** you want to integrate. +{% endhint %} + +**A.2. You have many accounts managed by** [**AWS Organizations**](https://docs.aws.amazon.com/organizations/latest/userguide/orgs\_introduction.html) + +If you have multiple accounts to integrate, choose the relevant option in the integration options menu. + +
+ +
-**a.2. You have many accounts managed by** [**AWS Organizations**](https://docs.aws.amazon.com/organizations/latest/userguide/orgs\_introduction.html) +
-1. Input your [Root ID](https://docs.aws.amazon.com/organizations/latest/userguide/orgs\_getting-started\_concepts.html) -2. Proceed to CloudFormation stack setup +Input your [Root ID](https://docs.aws.amazon.com/organizations/latest/userguide/orgs\_getting-started\_concepts.html), click `Save Stack` and proceed to CloudFormation stack setup (click `Go to New Report Template` to get redirected to AWS CloudFormation with prefilled settings). -
+
-
+
+ +
{% hint style="warning" %} Once you are redirected to AWS Cloud Formation ([next step](connecting-aws-account.md#3.-redirect-to-aws)), make sure to [Enable trusted access with AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-enable-trusted-access.html). {% endhint %} -#### b. You have an existing Cost and Usage Report set up and want to use it +{% hint style="info" %} +If you have multiple accounts not tied together through [AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs\_introduction.html), use [data-collection.md](../../fundamentals/settings/data-collection.md "mention") settings to add more accounts through **ad-hoc** single account integration option. +{% endhint %} -
+#### B. You have an existing Cost and Usage Report set up and want to use it Choose this option if: @@ -106,24 +145,53 @@ Choose this option if: * **Overwrite Report** file versioning * **Resource ID** level -b.1. You have only one account to integrate +{% hint style="info" %} +For the report settings input: + +**Report name** is the name of CUR report folder -* Input the details of your Cost and Usage report -* Proceed to CloudFormation stack setup +**Report prefix** is the path to CUR folder within the bucket (everything without the last `"/")` -
+**Report bucket** is S3 bucket name -
+ +{% endhint %} -b.2. You have many accounts managed by [AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs\_introduction.html) +**B.1. You have only one account to integrate** -* Input your [Root ID](https://docs.aws.amazon.com/organizations/latest/userguide/orgs\_getting-started\_concepts.html) -* Input the details of your Cost and Usage report -* Proceed to CloudFormation stack setup +If you have only one account to integrate, choose the relevant option in the integration options menu. -
+
-
+
+ +
+ +Input the details of your existing Cost and Usage report and proceed to CloudFormation stack setup (click `Go to New Report Template` to get redirected to AWS CloudFormation with prefilled settings). + +
+ +
+ +
+ +**B.2. You have many accounts managed by** [**AWS Organizations**](https://docs.aws.amazon.com/organizations/latest/userguide/orgs\_introduction.html) + +If you have multiple accounts to integrate, choose the relevant option in the integration options menu. + +
+ +
+ +
+ +Input your [Root ID](https://docs.aws.amazon.com/organizations/latest/userguide/orgs\_getting-started\_concepts.html), input the details of your Cost and Usage report and proceed to CloudFormation stack setup (click `Go to New Report Template` to get redirected to AWS CloudFormation with prefilled settings). + +
+ +
+ +
{% hint style="warning" %} Once you are redirected to AWS Cloud Formation ([next step](connecting-aws-account.md#3.-redirect-to-aws)), make sure to [Enable trusted access with AWS Organizations](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-enable-trusted-access.html). @@ -174,30 +242,36 @@ Once you initiate CF stack creation, it will take up to an hour to setup the req ![AWS console after CF stack launch](../../.gitbook/assets/connecting-aws-account-2-aws-cf-screen-2.png) -
+Monitor the CloudFormation creation log and troubleshoot as necessary. ### 5. Come back to Cloudthread App -Once the initial setup is complete, you will be able to see first cost insights in the app. +If the AWS integration went through (CloudFormation creation log finished with no errors), you will see the **success** message in Cloudthread app. + +
+ +
+ +
+ +Clock `Continue` to start using the app and seeing the first cost insights. -

Cloudthread App Welcome

+
{% hint style="info" %} AWS Cost and Usage Report (CUR) is being created (which can take up to 48 hours). {% endhint %} -

Cloudthread Inltial Dashboard

+
{% hint style="warning" %} Some sections of the app are grayed out right after the integration due to CUR integration timeline. {% endhint %} -This means that you'll have high level cost analytics available through the Cost Explorer API immediately when you login and that more granular resource level data will only be available when CUR data is ready. +This means that you'll have high level savings and cost analytics available through the Cost Explorer API immediately when you login and that more granular resource level data will only be available when CUR data is ready. -{% hint style="info" %} +{% hint style="success" %} Once the CUR file is ready Cloudthread will **notify** you, and you will be able to see deeper insights on the platform. -{% endhint %} -![Cloudthread App](../../.gitbook/assets/connecting-aws-account-11-dash.png) - -Often, when CUR file is created it does not have all the historical data – your AWS support must be contacted to **backfill** it. +**Note:** Often, when CUR file is created it does not have all the historical data – your AWS support must be contacted to **backfill** it. +{% endhint %} diff --git a/guides/onboarding/connecting-gcp-billing-account.md b/guides/onboarding/connecting-gcp-billing-account.md new file mode 100644 index 0000000..6ef3ae5 --- /dev/null +++ b/guides/onboarding/connecting-gcp-billing-account.md @@ -0,0 +1,132 @@ +# Connecting GCP Billing Account + +Connecting cloud account is an **essential** part of Cloudthread onboarding process and the most fundamental part of the setup. You cannot skip this step – your organization's cloud **savings, billing, and usage data** is essential for the platform to deliver value, i.e. help you to increase efficiency of your cloud spend. + +This is the guide for the **initial** data access setup, which is aimed at **GCP** **Billing** **Account** (see [GCP Cloud Billing documentation](https://cloud.google.com/billing/docs/concepts) for more information). This setup fully covers: + +## Cloudthread GCP access + +## Connecting Cloudthread + +### 1. Create and confirm Cloudthread account + +After your account is [created](https://app.core.cloudthread.io/sign-up/) and confirmed via email, you'll be prompted to get connected to your GCP environment by following the instructions. + +
+ +
+ +
+ +### 2. Set up GCP Billing in Big Query + +Execute following steps in your GCP Organization: + +1. Create a [Billing Account](https://cloud.google.com/billing/docs/how-to/create-billing-account) (if applicable) +2. Create a [Billing Project](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-setup#project) (if applicable) +3. [Link](https://cloud.google.com/billing/docs/how-to/modify-project#enable\_billing\_for\_a\_project) the Billing Project from Step 2 to the Billing Account from Step 1 (if applicable) +4. [Link](https://cloud.google.com/billing/docs/how-to/modify-project#enable\_billing\_for\_a\_project) the desired Resource Projects to the Billing Account from Step 1 (if applicable) +5. [Create](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-setup#create-bq-dataset) the Billing BigQuery Export Dataset +6. [Enable](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-setup#enable-bq-export) the Detailed usage cost export for the Billing Account from Step 1 using the Billing BigQuery Export Dataset from Step 3 + +Once you've completed the steps above click the button below to complete the integration by providing permissions to a Cloudthread generated Service Account. + +### 3. Setup GCP Service Account Permissions + +Once the billing reporting is set up in GCP, click `Setup GCP Service Account Permissions` and fill in the **Create GCP Collection Config** form. + +{% hint style="info" %} +**GCP Collection Config** is used to pull data from your GCP environment. +{% endhint %} + +![](../../.gitbook/assets/connecting-gcp-project-2-form.gif) + +#### 3.1 Add Recommender access for target Projects + +For the GCP projects you want to be covered by the [cost-savings](../../fundamentals/cost-savings/ "mention") features (leveraging GCP [Recommender API](https://console.cloud.google.com/apis/library/recommender.googleapis.com?project=cloudthread-production)) set up IAM permissions for Cloudthread in GCP Console: + +1. Copy the **Service Account** in the integration form in Cloudthread App +2. Go to [IAM](https://console.cloud.google.com/iam-admin/iam) in all the Projects where you'd like to collect savings opportunities +3. For each Project, click `+ Grant Access` +4. Paste the Service Account into the New principals field +5. Add `Recommender Viewer` permissions +6. **Save** the access +7. Ensure the [Recommender API](https://console.cloud.google.com/apis/library/recommender.googleapis.com?project=cloudthread-production) is enabled for each Project + +
+ +
+ +
+ +Once the permissions are added and saved for each target Project, come back to Cloudthread **Create GCP Collection Config** form and add `Recommender Project IDs` to the form field. + +#### 3.2 Add Billing access for target Projects + +_**Step 1. Add IAM permissions for Big Query access**_ + +1. Copy the **Service Account** in the integration form in Cloudthread App +2. Go to [IAM](https://console.cloud.google.com/iam-admin/iam) in your Billing Project +3. Click `+ Grant Access` +4. Paste the Service Account into the `New principals` field +5. Add the `BigQuery Job User` permissions +6. **Save** the access +7. Go to [BigQuery](http://127.0.0.1:5000/s/olpj9GP0AzTnIchRMGJ0/guides/setting-up-alerts-and-reports) in your Billing Project + +
+ +
+ +
+ +_**Step 2. Add permissions for Billing Dataset access**_ + +1. Navigate to your Billing BigQuery Export Dataset and click the data set +2. Click `+ Sharing` and then `Permissions` +3. Click `+ Add Principal` +4. Paste the Service Account into the `New principals` field +5. Add the `BigQuery Data Viewer` permissions +6. **Save** the access +7. Ensure the [BigQuery API](https://console.cloud.google.com/apis/library/bigquery.googleapis.com?project=cloudthread-production) is enabled for your Billing Project + +
+ +
+ +
+ +_**Step 3. Fill in Create GCP Collection Config form**_ + +Once the permissions are added and saved for each target Project, come back to Cloudthread **Create GCP Collection Config** form and: + +* Add `Billing Data Project ID` to the form field + * Make sure the Project has the billing data – it can be different from the one you enabled Recommender for. +* Add `Billing Data Table ID` to the form filed + + * To determine your Table ID go to [GCP BigQuery](https://console.cloud.google.com/bigquery) and select your Billing BigQuery Export Dataset and find the `Detailed usage cost` Table ID in the table Details + + + +### 4. Validate and Save the **GCP Collection Config** + +Once the permissions are set up in GCP console and GCP Collection Config form is filled, click `Validate` to make sure the integration has no errors. If this is the case, click `Save Config` to enable the integration. + +![](../../.gitbook/assets/connecting-gcp-project-2-service-account-6.gif) + +If the GCP integration went through, you will see the **success** message in Cloudthread app. + +
+ +
+ +
+ +Clock `Continue` to start using the app and seeing the first cost insights. + +
+ +
+ +{% hint style="warning" %} +Some sections of the app are grayed out right after the integration due to data pull integration timeline. +{% endhint %} diff --git a/guides/onboarding/managing-account-and-team-1.md b/guides/onboarding/managing-account-and-team-1.md index c26face..214e304 100644 --- a/guides/onboarding/managing-account-and-team-1.md +++ b/guides/onboarding/managing-account-and-team-1.md @@ -11,7 +11,7 @@ You have be an **Admin** in order to invite new team members. See [account-and-t {% hint style="info" %} Adding new users to the platform will enable the following: -* More **people** in you organization will be able to see cost **insights** in a convenient form +* More **people** in you organization will be able to see cost **insights** and [optimization-opportunities.md](../../fundamentals/cost-savings/key-concepts/optimization-opportunities.md "mention") in a convenient form * Engineers will be able to dig into the costs and unit metrics to understand how their workflows impact cloud spend and efficiency – this can enable **engineering accountability** * More people will be able to create [cost-view.md](../../fundamentals/cost-transparency/key-concepts/cost-view.md "mention") and [unit-metric.md](../../fundamentals/unit-metrics/key-concepts/unit-metric.md "mention") so that company's library has wider range of insights {% endhint %} @@ -19,14 +19,29 @@ Adding new users to the platform will enable the following: ## Detailed instructions 1. Go to **Settings** section from the left menu pane -2. Choose **Team Management** tab -3. Fill in the user invite form under the list of users - * All you need is User Name and e-mail -4. Push "Add New User" -5. Invited user should receive an e-mail and be able to sign up to Cloudthread +2. Choose **User Management** tab + + + +
+ +
+ +
+3. Click `Invite User` button +4. Fill in the user invite form + + * User Name and e-mail are required + * Choose team for the user if applicable, see [teams.md](../../fundamentals/settings/teams.md "mention") for more info + +
+ +
+ +
+5. Push "Add New User" +6. Invited user should receive an e-mail and be able to sign up to Cloudthread {% hint style="success" %} Cloudthread's [pricing](https://www.cloudthread.io/pricing) is **not based on number of users** – we do not want to create wrong incentives and discourage people in your organization to use the app and see valuable cloud efficiency insights. {% endhint %} - -![Adding a new User](../../.gitbook/assets/managing-account-and-team\_\_demo.gif) diff --git a/guides/onboarding/setting-up-teams.md b/guides/onboarding/setting-up-teams.md index cb603d8..7c0f3aa 100644 --- a/guides/onboarding/setting-up-teams.md +++ b/guides/onboarding/setting-up-teams.md @@ -21,15 +21,41 @@ Setting up teams allows to: ## Detailed instructions 1. Go to [settings](../../fundamentals/settings/ "mention") section from the left menu pane -2. Choose [teams.md](../../fundamentals/settings/teams.md "mention") tab -3. Fill in Team Name, Slack Channel and Cost Columns (if present) -4. Set up the **global team filter** - * This filter will appear in [cost-view-library.md](../../fundamentals/cost-transparency/cost-view-library.md "mention") under Team Global Filters section, it can be edited in the same as [cost-view.md](../../fundamentals/cost-transparency/key-concepts/cost-view.md "mention") are -5. Click "Save Team" -6. See the team appear in the table in Settings and in the Admin Team Assumption drop-down at the left menu pane -7. Add [cost-view.md](../../fundamentals/cost-transparency/key-concepts/cost-view.md "mention") to the newly created team from the table in the Settings as necessary +2. Choose [teams.md](../../fundamentals/settings/teams.md "mention") tab + + + +
+ +
+ +
+3. Click `Create New Team` +4. Fill in Team Name, add Slack channel (if applicable, see [#slack-integration](../../fundamentals/settings/slack-integration.md#slack-integration "mention") for details) + + + +
+ +
+ +
+5. Set up the **global team filter** + * There are three separate filter buckets: AWS, GCP and Custom Data (see [custom-data-api.md](../../fundamentals/custom-data-api.md "mention") for details) + * The filter is editable by Admin after the team is created +6. Click `Save Team` +7. See the team appear in the table in Settings and in the Admin Team Assumption drop-down at the left menu pane + +
+ +
+ +
+8. Add [cost-view.md](../../fundamentals/cost-transparency/key-concepts/cost-view.md "mention") to the newly created team as necessary * These Cost Views will be available for the team with the global filter applied on top (in addition to any existing filters) * By default, the Team members have no previously created custom Cost Views available to them -8. Assume the created team through the drop-down at the left menu pane to check if everything was set up correctly +9. Assume the created team through the drop-down at the left menu pane to check if everything was set up correctly -

Setting up Team Access

+{% hint style="success" %} +Team global filter is applied across all the features of Cloudthread, i.e. Savings Hub and Unit Metrics will be restricted based on filter rules. +{% endhint %} diff --git a/guides/optimizing-cloud-costs/analyzing-optimization-opportunities.md b/guides/optimizing-cloud-costs/analyzing-optimization-opportunities.md index 8b83b5e..261f258 100644 --- a/guides/optimizing-cloud-costs/analyzing-optimization-opportunities.md +++ b/guides/optimizing-cloud-costs/analyzing-optimization-opportunities.md @@ -1,4 +1,4 @@ -# Analyzing Optimization Opportunities +# Analyzing Savings Opportunities Once your AWS accounts are **connected** (see [onboarding](../onboarding/ "mention")), Cloudthread is ready to serve you **cost optimization insights.** This guide will walk you through the analysis of the [optimization-opportunities.md](../../fundamentals/cost-savings/key-concepts/optimization-opportunities.md "mention") on the platform. @@ -30,17 +30,34 @@ Analyzing [optimization-opportunities.md](../../fundamentals/cost-savings/key-co 1. Navigate to [savings-dashboard.md](../../fundamentals/cost-savings/savings-dashboard.md "mention") section in [cost-savings](../../fundamentals/cost-savings/ "mention") space in the menu to the left * You will see a dashboard with the high-level information on the state of cost optimization within your cloud environment - * If you have not created any [savings-threads.md](../../fundamentals/cost-savings/key-concepts/savings-threads.md "mention"), most of the tables of the dashboard will be empty, you will need to look at [#cost-insights-cards](../../fundamentals/cost-savings/savings-dashboard.md#cost-insights-cards "mention") and [#opportunity-tables](../../fundamentals/cost-savings/savings-dashboard.md#opportunity-tables "mention") to get the first impression of the savings potential + * If you have not created any [savings-threads.md](../../fundamentals/cost-savings/key-concepts/savings-threads.md "mention"), most of the tables of the dashboard will be empty, you will need to look at [#cost-insights-cards](../../fundamentals/cost-savings/savings-dashboard.md#cost-insights-cards "mention") and [#opportunity-tables](../../fundamentals/cost-savings/savings-dashboard.md#opportunity-tables "mention") to get the first impression of the savings potential + + + +
+ +
+ +
2. Navigate to [opportunities-explorer.md](../../fundamentals/cost-savings/opportunities-explorer.md "mention") section in [cost-savings](../../fundamentals/cost-savings/ "mention") space in the menu to the left to review the concrete optimization opportunities * You can also click "Explore Opportunities" at the top right of [#opportunity-tables](../../fundamentals/cost-savings/savings-dashboard.md#opportunity-tables "mention") - * You will see the [#unassigned-opportunities-table](../../fundamentals/cost-savings/opportunities-explorer.md#unassigned-opportunities-table "mention") with all the opportunities found by Cloudthread -3. Adjust **sorting** and **filter** [#unassigned-opportunities-table](../../fundamentals/cost-savings/opportunities-explorer.md#unassigned-opportunities-table "mention") + * You will see the [#opportunities-table](../../fundamentals/cost-savings/opportunities-explorer.md#opportunities-table "mention") with all the opportunities found by Cloudthread + + + +
+ +
+ +
+3. Adjust **sorting** and **filter** [#opportunities-table](../../fundamentals/cost-savings/opportunities-explorer.md#opportunities-table "mention") * Sort by estimated potential savings, difficulty or any other available dimensions (see [opportunities-explorer.md](../../fundamentals/cost-savings/opportunities-explorer.md "mention") for more details) 4. Click on Opportunity ID field for an opportunity that you want to explore deeper * You will be redirected to [#opportunity-details-page](../../fundamentals/cost-savings/opportunities-explorer.md#opportunity-details-page "mention") -5. If some of the opportunities revealed by Cloudthread seem **irrelevant**, select the corresponding rows of the [#unassigned-opportunities-table](../../fundamentals/cost-savings/opportunities-explorer.md#unassigned-opportunities-table "mention") by clicking checkmarks at the left of the row and then click [#archive-selected-button](../../fundamentals/cost-savings/opportunities-explorer.md#archive-selected-button "mention") +5. If some of the opportunities revealed by Cloudthread seem **irrelevant**, select the corresponding rows of the [#opportunities-table](../../fundamentals/cost-savings/opportunities-explorer.md#opportunities-table "mention") by clicking checkmarks at the left of the row and then click [#archive-selected-button](../../fundamentals/cost-savings/opportunities-explorer.md#archive-selected-button "mention") * Archiving can also be performed at a single row level by clicking trash bin icon at the right of the row {% hint style="success" %} Once you have an idea of cost savings opportunities present, you can start creating the **workflows** around them. See [creating-saving-threads.md](creating-saving-threads.md "mention") guide for further details. {% endhint %} + diff --git a/guides/optimizing-cloud-costs/creating-custom-optimization-opportunities.md b/guides/optimizing-cloud-costs/creating-custom-optimization-opportunities.md index e714b7d..bdf6364 100644 --- a/guides/optimizing-cloud-costs/creating-custom-optimization-opportunities.md +++ b/guides/optimizing-cloud-costs/creating-custom-optimization-opportunities.md @@ -1,4 +1,4 @@ -# Creating Custom Optimization Opportunities +# Creating Manual Savings Opportunities Cloudthread **automatically** analyzes your cloud environment and identifies [optimization-opportunities.md](../../fundamentals/cost-savings/key-concepts/optimization-opportunities.md "mention"). However, the platform also supports creation of **custom** opportunities for **ad-hoc** optimization needs (see [#optimization-type](../../fundamentals/cost-savings/key-concepts/optimization-opportunities.md#optimization-type "mention") for more details). @@ -21,8 +21,12 @@ Creating custom [optimization-opportunities.md](../../fundamentals/cost-savings/ ## Detailed instructions 1. Navigate to [opportunities-explorer.md](../../fundamentals/cost-savings/opportunities-explorer.md "mention") section in [cost-savings](../../fundamentals/cost-savings/ "mention") space in the menu to the left to review the concrete optimization opportunities -2. Click [#create-new-opportunity-button](../../fundamentals/cost-savings/opportunities-explorer.md#create-new-opportunity-button "mention") -3. Fill in the form by entering estimated **Cost Impact**, Opportunity **Description,** Opportunity **Difficulty** as well as by assigning [savings-threads.md](../../fundamentals/cost-savings/key-concepts/savings-threads.md "mention"), Resource ID, Opportunity **Type** and Recommendation - * ![](../../.gitbook/assets/custom-opportunity-guide-1-creation-form.png) - * As you can see you can form the optimization opportunity from scratch and assign it to actual cloud resource that Cloudthread platform sees in your cloud environment +2. Click [#new-manual-opportunity-button](../../fundamentals/cost-savings/opportunities-explorer.md#new-manual-opportunity-button "mention") +3. Fill in the form by entering estimated **Cost Impact**, Opportunity **Description,** Opportunity **Difficulty** as well as by assigning [savings-threads.md](../../fundamentals/cost-savings/key-concepts/savings-threads.md "mention"), Resource ID, Opportunity **Type** and Recommendation + +
+ +
+ +
4. You will see the custom opportunity in [opportunities-explorer.md](../../fundamentals/cost-savings/opportunities-explorer.md "mention") diff --git a/guides/optimizing-cloud-costs/creating-saving-threads.md b/guides/optimizing-cloud-costs/creating-saving-threads.md index 49bc923..b67945c 100644 --- a/guides/optimizing-cloud-costs/creating-saving-threads.md +++ b/guides/optimizing-cloud-costs/creating-saving-threads.md @@ -28,11 +28,30 @@ Creating [savings-threads.md](../../fundamentals/cost-savings/key-concepts/savin ## Detailed instructions 1. Navigate to [savings-threads-app-section.md](../../fundamentals/cost-savings/savings-threads-app-section.md "mention") in the menu to the left -2. Click [#create-new-thread-button](../../fundamentals/cost-savings/savings-threads-app-section.md#create-new-thread-button "mention") -3. Fill in the form by entering Thread **Name**, Thread **Description** and by choosing the [optimization-opportunities.md](../../fundamentals/cost-savings/key-concepts/optimization-opportunities.md "mention") from the table - * The table in the form is similar to [#unassigned-opportunities-table](../../fundamentals/cost-savings/opportunities-explorer.md#unassigned-opportunities-table "mention") in [opportunities-explorer.md](../../fundamentals/cost-savings/opportunities-explorer.md "mention") - * It is possible to create the thread from [opportunities-explorer.md](../../fundamentals/cost-savings/opportunities-explorer.md "mention") by choosing the opportunities in the table over there and clicking [#assign-to-thread-button](../../fundamentals/cost-savings/opportunities-explorer.md#assign-to-thread-button "mention") - * ![](../../.gitbook/assets/savings-threads-guide-1-thread-creation.png) -4. You will be redirected to [#savings-thread-details-page](../../fundamentals/cost-savings/savings-threads-app-section.md#savings-thread-details-page "mention") where you can see the enriched context -5. Click [#start-workflow-button](../../fundamentals/cost-savings/savings-threads-app-section.md#start-workflow-button "mention") to create Jira ticket associated with the created Thread +2. Filter the [#opportunities-table](../../fundamentals/cost-savings/opportunities-explorer.md#opportunities-table "mention") and choose the opportunities you want to group and include to [savings-threads.md](../../fundamentals/cost-savings/key-concepts/savings-threads.md "mention") + + + +
+ +
+ +
+3. Click [#create-new-thread-button](../../fundamentals/cost-savings/savings-threads-app-section.md#create-new-thread-button "mention") +4. Fill in the form by entering Thread **Name**, Thread **Description** + +
+ +
+ +
+5. Make sure the opportunities in the thread are correct, click `Edit` in the form to see the selected opportunities and to edit the selection + +
+ +
+ +
+6. Click `Create New Thread` – you will be redirected to [#savings-thread-details-page](../../fundamentals/cost-savings/savings-threads-app-section.md#savings-thread-details-page "mention") where you can see the enriched context +7. Click [#start-workflow-button](../../fundamentals/cost-savings/savings-threads-app-section.md#start-workflow-button "mention") to create Jira ticket associated with the created Thread * See [#jira-integration](../../fundamentals/settings/slack-integration.md#jira-integration "mention") for instructions on setting up the integration diff --git a/guides/optimizing-cloud-costs/supported-optimization-opportunities.md b/guides/optimizing-cloud-costs/supported-savings-opportunities.md similarity index 100% rename from guides/optimizing-cloud-costs/supported-optimization-opportunities.md rename to guides/optimizing-cloud-costs/supported-savings-opportunities.md diff --git a/quick-start.md b/quick-start.md index b0d6793..da0e370 100644 --- a/quick-start.md +++ b/quick-start.md @@ -8,21 +8,22 @@ ### AWS -In order to start with Cloudthread, follow these 3 steps: - 1. Create an account at [app.cloudthread.io/sign-up](https://app.cloudthread.io/sign-up) -2. Connect your AWS payer account: [connecting-aws-account.md](guides/onboarding/connecting-aws-account.md "mention") -3. Connect your AWS sub-accounts: [Broken link](broken-reference "mention") +2. Connect your AWS Management Account: [connecting-aws-account.md](guides/onboarding/connecting-aws-account.md "mention") + * Connect your AWS sub-accounts: [#aws](fundamentals/settings/data-collection.md#aws "mention") ### GCP -Coming soon! +1. Create an account at [app.cloudthread.io/sign-up](https://app.cloudthread.io/sign-up) +2. Connect your GCP Billing Project: [connecting-gcp-billing-account.md](guides/onboarding/connecting-gcp-billing-account.md "mention") ## Getting Started ### Guides: Head-start -Follow our handy guides to get started on the basics as quickly as possible: +{% hint style="success" %} +Follow our handy **guides** to get started on the basics as quickly as possible. +{% endhint %} {% content-ref url="guides/monitoring-cloud-costs/creating-custom-cost-views.md" %} [creating-custom-cost-views.md](guides/monitoring-cloud-costs/creating-custom-cost-views.md) @@ -46,7 +47,13 @@ Follow our handy guides to get started on the basics as quickly as possible: ### Fundamentals: Deep-dive -Learn the fundamentals of Cloudthread to get a deeper understanding of our main features: +{% hint style="success" %} +Learn the fundamentals of Cloudthread to get a deeper understanding of our **main features.** +{% endhint %} + +{% content-ref url="fundamentals/cost-savings/" %} +[cost-savings](fundamentals/cost-savings/) +{% endcontent-ref %} {% content-ref url="fundamentals/cost-transparency/" %} [cost-transparency](fundamentals/cost-transparency/) @@ -60,10 +67,6 @@ Learn the fundamentals of Cloudthread to get a deeper understanding of our main [tag-assistant](fundamentals/tag-assistant/) {% endcontent-ref %} -{% content-ref url="fundamentals/cost-savings/" %} -[cost-savings](fundamentals/cost-savings/) -{% endcontent-ref %} - {% content-ref url="fundamentals/notifications/" %} [notifications](fundamentals/notifications/) {% endcontent-ref %}