What is cloudconsolelink?

This project for generate console links for AWS, GCP, Azure and OCI cloud resources, and web links for GitHub, GitLab, Bitbucket and Azure DevOps entities

Install

Run pip install cloudconsolelink to install our code

For local development, install the package with dev extras:

pip install -e '.[dev]'

Verification shortcuts:

make test
make coverage
make test-arn
make test-aws-links
make check

Usage

Import Package

For AWS

from cloudconsolelink.clouds.aws import AWSLinker

For Azure

from cloudconsolelink.clouds.azure import AzureLinker

For GCP

from cloudconsolelink.clouds.gcp import GCPLinker

For OCI

from cloudconsolelink.clouds.oci import OCILinker

For GitHub, GitLab, Bitbucket, Azure DevOps

from cloudconsolelink.clouds.git import GitLinker

For container images (ECR, GAR/GCR, ACR, Docker Hub, OCIR)

from cloudconsolelink.clouds.registry import image_console_link

To get console link

call method get_console_link()

The Followings Are The Some Example

AWS:

from cloudconsolelink.clouds.aws import AWSLinker

aws = AWSLinker()

arn = "arn:aws:ec2:us-east1:1234567890:instance/instance1"

console_link = aws.get_console_link(arn=arn)

Azure Management:

from cloudconsolelink.clouds.azure import AzureLinker

azure = AzureLinker()

id = "/subscriptions/5592e8dc/resourceGroups/testgroup"
primary_ad_domain_name = "QA123.onmicrosoft.com"

console_link = azure.get_console_link(id=id, primary_ad_domain_name=primary_ad_domain_name)

Azure IAM:

from cloudconsolelink.clouds.azure import AzureLinker

azure = AzureLinker()

id = "1234567890"
iam_entity_type = "user"

console_link = azure.get_console_link(id=id, iam_entity_type=iam_entity_type)

GCP:

from cloudconsolelink.clouds.gcp import GCPLinker

gcp = GCPLinker()


bucket_name = "xyz"
resource_name = "storage_bucket"

console_link = gcp.get_console_link(bucket_name=bucket_name, resource_name=resource_name)

Container image (ECR, GAR/GCR, ACR, Docker Hub, OCIR):

from cloudconsolelink.clouds.registry import image_console_link

# Provider is detected from the registry hostname of the image reference.
console_link = image_console_link(
    "602401143452.dkr.ecr.us-east-2.amazonaws.com/amazon-k8s-cni-init"
)

# Azure Container Registry needs subscription/resource-group hints for a deep
# link (they are not present in the image reference); without them it degrades
# to a registry browse link.
console_link = image_console_link(
    "myregistry.azurecr.io/app",
    subscription_id="5592e8dc-...",
    resource_group="my-rg",
)

Git providers:

from cloudconsolelink.clouds.git import GitLinker

git = GitLinker()

git.get_console_link("github", "branch", owner="acme", repo="api", branch="main")
# https://github.com/acme/api/tree/main

# Self-hosted GitHub Enterprise / GitLab: pass base_url
git.get_console_link("gitlab", "project", base_url="https://gitlab.acme.com", project_path="platform/api")
# https://gitlab.acme.com/platform/api

Resource names per provider are the keys of LINKS in cloudconsolelink/clouds/git/__init__.py.

get_console_link() parameters description:

AWS:

1. arn: arn of resource

Azure:

IAM:

1. iam_entity_type: type of iam resource(user, group, application)
2. id: object id

Management:

1. id: id of entity
2. primary_ad_domain_name: name of the active derectory primary domain

GCP:

1. resource_name: name of resource(storage_bucket, compute_instance, compute_instance_vpc_network, compute_instance_vpc_network_subnet, compute_instance_disk, compute_firewall_rule, compute_forwarding_rule, api, api_config, api_gateway, big_table_instance, big_table_cluster, big_table, big_table_backup, cloud_function, kms_key_ring, kms_key, dns_zone, dns_resource_record_set, gke_cluster, sql_instance, sql_user, service_account, service_account_key, iam_role, iam_group, iam_user, firestore_collection, cloud_run_revision, cloud_run_service)
2. project_id
3. region
4. zone
5. bucket_name
6. instance_name
7. network_name
8. subnet_name
9. rule_name
10. api_name
11. managed_service_name
12. api_config_name
13. api_configuration_id
14. api_gateway_name
15. bigtable_instance_name
16. bigtable_cluster_id
17. bigtable_table_id
18. cloud_function_name
19. kms_key_ring_name
20. kms_key_name
21. dns_zone_name
22. dns_rrset_name
23. dns_type
24. gke_cluster_name
25. sql_instance_name
26. service_account_unique_id
27. role_id
28. group_unique_id
29. firestore_collection_name
30. cloud_run_service_name

The full, current list of GCP resource names is the resources dict in cloudconsolelink/clouds/gcp/__init__.py.

Who uses cloudconsolelink?

1. Cloudanix
2. {Your company here} :-)

If your organization uses Cloudconsolelink, please file a PR and update this list.