Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions examples/infrastructure-resources-example.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
{
"name": "auth-service",
"type": "project",
"languages": "golang",
"owner": "platform-team",
"version": "2.1.0",
"description": "Authentication and authorization service",
"repository": "https://github.com/company/auth-service",
"platform": "kubernetes",
"sla": {
"level": "critical",
"uptime_percentage": 99.99,
"response_time_ms": 100,
"description": "Mission-critical authentication service"
},
"infrastructure_resources": [
{
"id": "infra-1",
"name": "users-db",
"type": "database_postgresql",
"description": "Primary PostgreSQL database for user data",
"provider": "AWS",
"region": "us-east-1",
"endpoint": "users-db.cluster-abc123.us-east-1.rds.amazonaws.com:5432",
"metadata": {
"instance_type": "db.r5.xlarge",
"storage": "500GB",
"multi_az": "true",
"backup_retention": "7 days"
}
},
{
"id": "infra-2",
"name": "sessions-cache",
"type": "cache_redis",
"description": "Redis cache for user sessions",
"provider": "AWS",
"region": "us-east-1",
"endpoint": "sessions-cache.abc123.cache.amazonaws.com:6379",
"metadata": {
"node_type": "cache.r5.large",
"num_nodes": "3",
"engine_version": "7.0"
}
},
{
"id": "infra-3",
"name": "auth-secrets",
"type": "security_secrets_manager",
"description": "Secrets Manager for API keys and credentials",
"provider": "AWS",
"region": "us-east-1",
"endpoint": "secretsmanager.us-east-1.amazonaws.com",
"metadata": {
"rotation_enabled": "true",
"rotation_days": "30"
}
},
{
"id": "infra-4",
"name": "auth-lb",
"type": "network_load_balancer",
"description": "Application Load Balancer for auth service",
"provider": "AWS",
"region": "us-east-1",
"endpoint": "auth-lb-123456789.us-east-1.elb.amazonaws.com",
"metadata": {
"type": "application",
"scheme": "internet-facing",
"ssl_policy": "ELBSecurityPolicy-TLS-1-2-2017-01"
}
},
{
"id": "infra-5",
"name": "audit-logs-bucket",
"type": "storage_s3",
"description": "S3 bucket for audit logs",
"provider": "AWS",
"region": "us-east-1",
"endpoint": "s3://audit-logs-auth-service",
"metadata": {
"versioning": "enabled",
"encryption": "AES256",
"lifecycle_policy": "90 days to Glacier"
}
}
],
"dependencies_in": [
"user-profile-service",
"notification-service"
],
"dependencies_out": [
"api-gateway",
"mobile-app",
"web-app"
]
}
104 changes: 103 additions & 1 deletion generated/openapiv2/apidocs.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -1168,6 +1168,14 @@
"vulnerability_summary": {
"$ref": "#/definitions/v1alpha1VulnerabilitySummary",
"title": "Vulnerability summary for security monitoring"
},
"infrastructure_resources": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/v1alpha1InfrastructureResource"
},
"title": "Infrastructure resources used by this service"
}
}
},
Expand Down Expand Up @@ -1411,8 +1419,16 @@
},
"vulnerability_summary": {
"$ref": "#/definitions/v1alpha1VulnerabilitySummary",
"description": "Note: Version management (available_versions, latest_version, reference_version) \n is handled separately via UpdateVersions endpoint",
"title": "Vulnerability summary for security monitoring"
},
"infrastructure_resources": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/v1alpha1InfrastructureResource"
},
"description": "Note: Version management (available_versions, latest_version, reference_version) \n is handled separately via UpdateVersions endpoint",
"title": "Infrastructure resources used by this service"
}
}
},
Expand Down Expand Up @@ -1723,6 +1739,92 @@
}
}
},
"v1alpha1InfrastructureResource": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "Unique identifier for the resource"
},
"name": {
"type": "string",
"title": "Display name (e.g., \"users-db\", \"assets-bucket\")"
},
"type": {
"$ref": "#/definitions/v1alpha1InfrastructureType",
"title": "Type of infrastructure resource"
},
"description": {
"type": "string",
"title": "Optional description"
},
"provider": {
"type": "string",
"title": "Cloud provider (AWS, Azure, GCP, Scaleway, etc.)"
},
"region": {
"type": "string",
"title": "Region/location"
},
"endpoint": {
"type": "string",
"title": "Connection endpoint or URL"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "Additional metadata (size, tier, etc.)"
},
"connected_services": {
"type": "array",
"items": {
"type": "string"
},
"title": "Services that use this resource"
}
},
"title": "Infrastructure resource (database, storage, API gateway, etc.)"
},
"v1alpha1InfrastructureType": {
"type": "string",
"enum": [
"INFRASTRUCTURE_TYPE_UNSPECIFIED",
"database_rds",
"database_dynamodb",
"database_mongodb",
"database_postgresql",
"database_mysql",
"database_redis",
"database_elasticsearch",
"storage_s3",
"storage_efs",
"storage_ebs",
"network_load_balancer",
"network_api_gateway",
"network_cdn",
"network_vpc",
"network_nat_gateway",
"messaging_sqs",
"messaging_sns",
"messaging_kafka",
"messaging_rabbitmq",
"cache_redis",
"cache_memcached",
"cache_cloudfront",
"security_waf",
"security_secrets_manager",
"security_kms",
"monitoring_cloudwatch",
"monitoring_prometheus",
"monitoring_grafana",
"other_custom"
],
"default": "INFRASTRUCTURE_TYPE_UNSPECIFIED",
"description": "AWS RDS / Azure SQL / GCP Cloud SQL\n - database_dynamodb: AWS DynamoDB / Azure Cosmos DB\n - database_mongodb: MongoDB Atlas / DocumentDB\n - database_postgresql: PostgreSQL\n - database_mysql: MySQL / MariaDB\n - database_redis: Redis / ElastiCache\n - database_elasticsearch: Elasticsearch / OpenSearch\n - storage_s3: Storage\n\nAWS S3 / Azure Blob / GCP Cloud Storage\n - storage_efs: AWS EFS / Azure Files / GCP Filestore\n - storage_ebs: AWS EBS / Azure Disk\n - network_load_balancer: Networking\n\nLoad Balancer (ALB, NLB, etc.)\n - network_api_gateway: API Gateway\n - network_cdn: CloudFront / Azure CDN / GCP CDN\n - network_vpc: VPC / Virtual Network\n - network_nat_gateway: NAT Gateway\n - messaging_sqs: Messaging \u0026 Queues\n\nAWS SQS / Azure Queue / GCP Pub/Sub\n - messaging_sns: AWS SNS / Azure Service Bus\n - messaging_kafka: Kafka / MSK / Event Hubs\n - messaging_rabbitmq: RabbitMQ / Amazon MQ\n - cache_redis: Caching\n\nRedis / ElastiCache\n - cache_memcached: Memcached\n - cache_cloudfront: CloudFront cache\n - security_waf: Security\n\nWAF (Web Application Firewall)\n - security_secrets_manager: Secrets Manager / Key Vault\n - security_kms: KMS / Key Management\n - monitoring_cloudwatch: Monitoring\n\nCloudWatch / Azure Monitor\n - monitoring_prometheus: Prometheus\n - monitoring_grafana: Grafana\n - other_custom: Other\n\nCustom infrastructure resource",
"title": "- database_rds: Databases"
},
"v1alpha1Languages": {
"type": "string",
"enum": [
Expand Down
Loading
Loading