Skip to content

Add cloudstack_limits data source and resource #197

New issue

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

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

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

ianc769
Copy link

@ianc769 ianc769 commented Jul 15, 2025

Adding limits as a terraform managed resource option -> https://cloudstack.apache.org/api/apidocs-4.20/apis/updateResourceLimit.html

Contributes to #82

Using this code for example:

resource "random_uuid" "example" {
}

resource "cloudstack_domain" "example" {
  name             = "example-domain"
  network_domain   = "example.local"
  domain_id        = random_uuid.example.result
  parent_domain_id = "65c9befb-1a1c-11f0-85c0-460f7764ea25"
}

# Set limit in a domain
resource "cloudstack_limits" "cpu_limit" {
  type       = "cpu"
  max        = 42
  domainid   = random_uuid.example.result
  depends_on = [cloudstack_domain.example]

}

# Set volume limit for a specific account in a domain
resource "cloudstack_limits" "volume_limit" {
  type     = "volume"
  max      = 22
  account  = "limits.test"
  domainid = "861bf423-e531-48dc-9bdc-a3183ae0fb0f"
}

# Set primary storage limit for a project
resource "cloudstack_limits" "storage_limit" {
  type      = "primarystorage"
  max       = 1423                                   # GB
  projectid = "c3638a06-9598-4c34-8f89-891beda43eca" // Example project ID
}
Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  + create

Terraform will perform the following actions:

  # cloudstack_domain.example will be created
  + resource "cloudstack_domain" "example" {
      + domain_id        = (known after apply)
      + id               = (known after apply)
      + name             = "example-domain"
      + network_domain   = "example.local"
      + parent_domain_id = "65c9befb-1a1c-11f0-85c0-460f7764ea25"
    }

  # cloudstack_limits.cpu_limit will be created
  + resource "cloudstack_limits" "cpu_limit" {
      + domainid = (known after apply)
      + id       = (known after apply)
      + max      = 42
      + type     = "cpu"
    }

  # cloudstack_limits.storage_limit will be created
  + resource "cloudstack_limits" "storage_limit" {
      + id        = (known after apply)
      + max       = 1423
      + projectid = "c3638a06-9598-4c34-8f89-891beda43eca"
      + type      = "primarystorage"
    }

  # cloudstack_limits.volume_limit will be created
  + resource "cloudstack_limits" "volume_limit" {
      + account  = "limits.test"
      + domainid = "861bf423-e531-48dc-9bdc-a3183ae0fb0f"
      + id       = (known after apply)
      + max      = 22
      + type     = "volume"
    }

  # random_uuid.example will be created
  + resource "random_uuid" "example" {
      + id     = (known after apply)
      + result = (known after apply)
    }

Plan: 5 to add, 0 to change, 0 to destroy.
random_uuid.example: Creating...
random_uuid.example: Creation complete after 0s [id=3e435b24-880a-6bae-50a6-fbd5c9be402b]
cloudstack_limits.volume_limit: Creating...
cloudstack_limits.storage_limit: Creating...
cloudstack_domain.example: Creating...
cloudstack_domain.example: Creation complete after 0s [id=3e435b24-880a-6bae-50a6-fbd5c9be402b]
cloudstack_limits.volume_limit: Creation complete after 0s [id=2-account-limits.test-861bf423-e531-48dc-9bdc-a3183ae0fb0f]
cloudstack_limits.cpu_limit: Creating...
cloudstack_limits.storage_limit: Creation complete after 0s [id=10-project-c3638a06-9598-4c34-8f89-891beda43eca]
cloudstack_limits.cpu_limit: Creation complete after 0s [id=8-domain-3e435b24-880a-6bae-50a6-fbd5c9be402b]

Apply complete! Resources: 5 added, 0 changed, 0 destroyed.

- Implemented data source for retrieving CloudStack resource limits.
- Added resource management for setting and updating resource limits for accounts, domains, and projects.
- Updated documentation for cloudstack_limits with usage examples and argument references.
@DaanHoogland DaanHoogland requested a review from Copilot August 6, 2025 08:04
Copilot

This comment was marked as outdated.

…ted resources

Implimenting copilot suggestions for d.GetOk
@ianc769 ianc769 requested a review from Copilot August 7, 2025 18:17
Copilot

This comment was marked as outdated.

Co-authored-by: Copilot <[email protected]>
@ianc769 ianc769 requested a review from Copilot August 7, 2025 18:27
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds CloudStack limits as both a Terraform data source and resource, enabling management of resource limits for accounts, domains, and projects within CloudStack through the updateResourceLimit API.

  • Adds cloudstack_limits resource for managing resource limits with support for various resource types (instance, ip, volume, snapshot, template, project, network, vpc, cpu, memory, primarystorage, secondarystorage)
  • Adds cloudstack_limits data source for retrieving existing resource limit information
  • Provides comprehensive test coverage for different resource types and scenarios including unlimited and zero limits

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
cloudstack/provider.go Registers the new data source and resource in the provider
cloudstack/resource_cloudstack_limits.go Core resource implementation with CRUD operations for managing CloudStack limits
cloudstack/data_source_cloudstack_limits.go Data source implementation for reading CloudStack resource limits
cloudstack/resource_cloudstack_limits_test.go Comprehensive test suite covering various limit scenarios and resource types
website/docs/r/limits.html.markdown Resource documentation with usage examples and parameter descriptions
website/docs/d/limits.html.markdown Data source documentation with usage examples and attribute descriptions

resource "cloudstack_limits" "project_limit" {
type = "primarystorage"
max = 1000
domainid = cloudstack_domain.test_domain.id
Copy link
Preview

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test configuration testAccCloudStackLimits_project is missing the actual project resource creation. It only sets a domain-level limit instead of a project-specific limit. This doesn't match the test name and will cause the test to fail since no project is created for the projectid parameter.

Suggested change
domainid = cloudstack_domain.test_domain.id
resource "cloudstack_project" "test_project" {
name = "test-project-limits"
display_text = "Test Project for Limits"
domainid = cloudstack_domain.test_domain.id
}
resource "cloudstack_limits" "project_limit" {
type = "primarystorage"
max = 1000
projectid = cloudstack_project.test_project.id
domainid = cloudstack_domain.test_domain.id

Copilot uses AI. Check for mistakes.

// If the user set max to 0 but the API returned -1, keep it as 0 in the state
if limit.Max == -1 && d.Get("max").(int) == 0 {
log.Printf("[DEBUG] API returned -1 for a limit set to 0, keeping it as 0 in state")
d.Set("max", 0)
Copy link
Preview

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This condition assumes that d.Get("max") will always return an int, but if the max field is not set in the schema, this could cause a panic. Consider checking if the value exists first with d.GetOk("max") before type assertion.

Suggested change
d.Set("max", 0)
if limit.Max == -1 {
if v, ok := d.GetOk("max"); ok && v.(int) == 0 {
log.Printf("[DEBUG] API returned -1 for a limit set to 0, keeping it as 0 in state")
d.Set("max", 0)
} else {
d.Set("max", limit.Max)
}

Copilot uses AI. Check for mistakes.

},
}
}

Copy link
Preview

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The import functionality uses ImportStatePassthroughContext but the documentation shows specific import ID formats like 2-acct1-domain-uuid. Consider implementing a custom import function that properly parses these composite IDs or update the documentation to reflect the actual import behavior.

Suggested change
StateContext: resourceCloudStackLimitsImport,
},
}
}
// resourceCloudStackLimitsImport parses composite import IDs and sets resource fields accordingly.
func resourceCloudStackLimitsImport(ctx context.Context, d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
// Expected format: type-account-domainid or type-projectid
// Example: 2-acct1-domain-uuid or 2-projectid
parts := strings.Split(d.Id(), "-")
if len(parts) < 2 {
return nil, fmt.Errorf("unexpected import ID format (%q), expected type-account-domainid or type-projectid", d.Id())
}
// Set type
typeInt, err := strconv.Atoi(parts[0])
if err != nil {
return nil, fmt.Errorf("invalid type value in import ID: %s", parts[0])
}
var typeStr string
for k, v := range resourceTypeMap {
if v == typeInt {
typeStr = k
break
}
}
if typeStr == "" {
return nil, fmt.Errorf("unknown type value in import ID: %d", typeInt)
}
if err := d.Set("type", typeStr); err != nil {
return nil, err
}
// Set other fields
if len(parts) == 3 {
// type-account-domainid
if err := d.Set("account", parts[1]); err != nil {
return nil, err
}
if err := d.Set("domainid", parts[2]); err != nil {
return nil, err
}
} else if len(parts) == 2 {
// type-projectid
if err := d.Set("projectid", parts[1]); err != nil {
return nil, err
}
} else {
return nil, fmt.Errorf("unexpected import ID format (%q), expected type-account-domainid or type-projectid", d.Id())
}
return []*schema.ResourceData{d}, nil
}

Copilot uses AI. Check for mistakes.

@kiranchavala kiranchavala added this to the v0.6.0 milestone Aug 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants