Skip to content

Commit

Permalink
[#1211] update create-app env templates
Browse files Browse the repository at this point in the history
  • Loading branch information
4upz committed Feb 7, 2024
1 parent 5649a68 commit eda841d
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ AWS_BILLING_ACCOUNT_NAME=your-billing-account-name
# Cost allocation tags used to group resources, see https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
AWS_RESOURCE_TAG_NAMES=[] # eg. ["user:Environment","user:CostCenter","aws:CreatedBy"]

# Variables needed for the Cloud Usage API (Higher Accuracy) approach with AWS:
# Specifies which AWS accounts to include in estimations. This is required if using the Cloud Usage API (Higher Accuracy) approach with AWS
# If you are using the Billing Data (Holistic) approach with AWS, it will fetch usage for all accounts under the billing account by default.
AWS_ACCOUNTS=[{"id":"your-account-id","name":"Your AWS Account"}]

# Optionally set this to "GCP" or "AWS" if your application is deployed to AWS or GCP.
Expand All @@ -44,8 +45,11 @@ GCP_BILLING_PROJECT_NAME=your-billing-account-name
GCP_VCPUS_PER_GKE_CLUSTER=10
GCP_VCPUS_PER_CLOUD_COMPOSER_ENVIRONMENT=10

# Variables needed for the Cloud Usage API (Higher Accuracy) approach with GCP:
GCP_PROJECTS=[{"id":"your-gcp-project-id","name":"Your GCP Project"}]
# Defines which GCP projects to include in estimations. This is required if using the Cloud Usage API (Higher Accuracy) approach with GCP
# If you are using the Billing Data (Holistic) approach with GCP, it will fetch usage for all projects under the exported billing account by default.
GCP_PROJECTS=[{"id":"your-gcp-project-id","name"?:"Your GCP Project"}]

GCP_RESOURCE_TAG_NAMES=[] # ["tag:ise-api-enabler-access, label:goog-composer-location, project:twproject"]

# Azure

Expand All @@ -60,13 +64,36 @@ AZURE_TENANT_ID=your-azure-tenant-id
# Optionally set this to "GCP" if your Azure credentials are stored in Google Secrets Manager.
AZURE_AUTH_MODE=default

# Azure resource tag names to include if present, include resourceGroup as a tag name if needed:
AZURE_RESOURCE_TAG_NAMES=["resourceGroup"] # eg. ["resourceGroup","project","customer"]

# To avoid rate limiting, azure estimations can be chunked by days
AZURE_CONSUMPTION_CHUNKS_DAYS=0

# To avoid rate limiting, asynchronous consumption management calls can be chunked by subscription
AZURE_SUBSCRIPTION_CHUNKS=0

# List of Azure subscriptions to include in estimations (all subscriptions are fetched by default)
AZURE_SUBSCRIPTIONS=["subscription-1", "subscription-2"]

# Ali

ALI_ACCESS_KEY=your-alicloud-access-key
ALI_ACCESS_SECRET=your-alicloud-access-secret

# Cache

# Optionally set which cache you are using (defaults to local)
CACHE_MODE=MONGODB

# If CACHE_MODE is set to 'MONGODB', you need to provide the URI to your db and a file path to your credentials
MONGODB_URI=mongodb://localhost:27017
MONGODB_CREDENTIALS=/keys/mongodb-certificate.pem

# If CACHE_MODE is set to 'GCS', you need to provide the name of the GCS bucket
GCS_CACHE_BUCKET_NAME=ccf-estimates-staging
GCS_CACHE_BUCKET_NAME=ccf-estimates-staging

# Additional Configurations

# To enable the use of the Electricity Maps API for carbon intensity data, set the following variable to your token:
ELECTRICITY_MAPS_TOKEN=your-electricity-maps-token
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ AWS_BILLING_ACCOUNT_NAME=your-billing-account-name
# Cost allocation tags used to group resources, see https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html
AWS_RESOURCE_TAG_NAMES=[] # eg. ["user:Environment","user:CostCenter","aws:CreatedBy"]

# Variables needed for the Cloud Usage API (Higher Accuracy) approach with AWS:
# Specifies which AWS accounts to include in estimations. This is required if using the Cloud Usage API (Higher Accuracy) approach with AWS
# If you are using the Billing Data (Holistic) approach with AWS, it will fetch usage for all accounts under the billing account by default.
AWS_ACCOUNTS=[{"id":"your-account-id","name":"Your AWS Account"}]

# Optionally set this to "GCP" or "AWS" if your application is deployed to AWS or GCP.
Expand All @@ -44,9 +45,13 @@ GCP_BILLING_PROJECT_NAME=your-billing-account-name
GCP_VCPUS_PER_GKE_CLUSTER=10
GCP_VCPUS_PER_CLOUD_COMPOSER_ENVIRONMENT=10

# Variables needed for the Cloud Usage API (Higher Accuracy) approach with GCP:
# Defines which GCP projects to include in estimations. This is required if using the Cloud Usage API (Higher Accuracy) approach with GCP
# If you are using the Billing Data (Holistic) approach with GCP, it will fetch usage for all projects under the exported billing account by default.
GCP_PROJECTS=[{"id":"your-gcp-project-id","name":"Your GCP Project"}]

# Google Cloud resource tag or label names to include if present
GCP_RESOURCE_TAG_NAMES=[] # ["tag:ise-api-enabler-access, label:goog-composer-location, project:twproject"]

# Azure

# Variables needed for the Billing Data (Holistic) approach with Azure:
Expand All @@ -66,9 +71,12 @@ AZURE_RESOURCE_TAG_NAMES=["resourceGroup"] # eg. ["resourceGroup","project","cus
# To avoid rate limiting, azure estimations can be chunked by days
AZURE_CONSUMPTION_CHUNKS_DAYS=0

# To avoid rate limiting, asynchronous consumption management calls can be chunked by subscription (takes precedence over AZURE_SUBSCRIPTION_CHUNKS)
# To avoid rate limiting, asynchronous consumption management calls can be chunked by subscription
AZURE_SUBSCRIPTION_CHUNKS=0

# List of Azure subscriptions to include in estimations (all subscriptions are fetched by default)
AZURE_SUBSCRIPTIONS=["subscription-1", "subscription-2"]

# Cache

# Optionally set which cache you are using (defaults to local)
Expand All @@ -91,4 +99,9 @@ ON_PREMISE_CPU_UTILIZATION_DESKTOP=40
# Optionally set average watts value to be used for the different machine type estimations. This will override you CPU_UTILIZATION value
ON_PREMISE_AVG_WATTS_SERVER=40
ON_PREMISE_AVG_WATTS_LAPTOP=40
ON_PREMISE_AVG_WATTS_DESKTOP=40
ON_PREMISE_AVG_WATTS_DESKTOP=40

#Additional Configuration

# To enable the use of the Electricity Maps API for carbon intensity data, set the following variable to your token:
ELECTRICITY_MAPS_TOKEN=your-electricity-maps-token

0 comments on commit eda841d

Please sign in to comment.