Skip to content

Latest commit

 

History

History
310 lines (248 loc) · 10.2 KB

README.adoc

File metadata and controls

310 lines (248 loc) · 10.2 KB
Raw

IBM Cloud VPC

Introduction

The goal of this project is to manage IBM Cloud VPC (Virtual Private cloud)

Install

Download and install the IBM Ansible collection.

$ ansible-galaxy collection install ibm.cloudcollection

Create API Key

These playbooks require that an IBM Cloud API key exists.

Using the API Keys section of the IBM Cloud web site, create a new API key.

Usage Guide

Before using these playbooks, make sure that the following environment variables are defined.

Export the API key using the IC_API_KEY environment variable:

export IC_API_KEY=<YOUR_API_KEY_HERE>

e.g.

export IC_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Export the IBM Cloud region using the IC_REGION environment variable:

export IC_REGION=<REGION_NAME_HERE>

e.g.

export IC_REGION=eu-de

VPC - Virtual Private Cloud

The VPC playbooks gather the information from the vpc-vars.yml variables file. The variables used are the following:

Variable Value Description

name_prefix

snowdrop

Prefix used to name the different resources.

zone

eu-de-1

Zone where the resources will be created.

ipv4_cidr_block

10.243.0.0/24

The IPv4 range of the subnet.

Create a new VPC

Create a new VPC.

$ ansible-playbook vpc-create.yml

This command will also create:

  • a VPC Subnet

  • a Public Gateway

Get VPC information

To get the VPC information use the vpc-info playbook.

e.g.

$ ansible-playbook vpc-info.yml

PLAY [Describe IBM Cloud VPC information] **************************************

TASK [Gathering Facts] *********************************************************
Thursday 21 October 2021  12:47:08 +0200 (0:00:00.011)       0:00:00.011 ******
ok: [localhost]

TASK [Fetch the variables from var file] ***************************************
Thursday 21 October 2021  12:47:09 +0200 (0:00:01.010)       0:00:01.021 ******
ok: [localhost]

TASK [Get the vpc details] *****************************************************
Thursday 21 October 2021  12:47:09 +0200 (0:00:00.020)       0:00:01.042 ******
ok: [localhost]

TASK [Print VPC facts] *********************************************************
Thursday 21 October 2021  12:47:20 +0200 (0:00:10.187)       0:00:11.230 ******
ok: [localhost] => {
    "msg": {
        "classic_access": false,
        "crn": "crn:v1:bluemix:public:is:eu-de:a/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx::vpc:xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "cse_source_addresses": [
            {
                "address": "0.0.0.0",
                "zone_name": "eu-de-1"
            },
            {
                "address": "0.0.0.0",
                "zone_name": "eu-de-2"
            },
            {
                "address": "0.0.0.0",
                "zone_name": "eu-de-3"
            }
        ],
        "default_network_acl": "xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "default_network_acl_crn": "crn:v1:bluemix:public:is:eu-de:a/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx::network-acl:xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "default_network_acl_name": "xxxx-xxxx-xxxx-xxxx",
        "default_routing_table": "xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "default_routing_table_name": "xxxx-xxxx-xxxx-xxxx",
        "default_security_group": "xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "default_security_group_crn": "crn:v1:bluemix:public:is:eu-de:a/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx::security-group:xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "default_security_group_name": "xxxx-xxxx-xxxx-xxxx",
        "id": "xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "name": "snowdrop-vpc",
        "resource_controller_url": "https://cloud.ibm.com/vpc-ext/network/vpcs",
        "resource_crn": "crn:v1:bluemix:public:is:eu-de:a/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx::vpc:xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "resource_group": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "resource_group_name": "Default",
        "resource_name": "snowdrop-vpc",
        "resource_status": "available",
        "security_group": [
            {
                "group_id": "rxxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
                "group_name": "xxxx-xxxx-xxxx-xxxx",
                "rules": [
                    {
                        "code": 0,
                        "direction": "outbound",
                        "ip_version": "ipv4",
                        "port_max": 0,
                        "port_min": 0,
                        "protocol": "all",
                        "remote": "0.0.0.0/0",
                        "rule_id": "xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
                        "type": 0
                    },
                    {
                        "code": 0,
                        "direction": "inbound",
                        "ip_version": "ipv4",
                        "port_max": 0,
                        "port_min": 0,
                        "protocol": "all",
                        "remote": "xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
                        "rule_id": "xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
                        "type": 0
                    }
                ]
            }
        ],
        "status": "available",
        "subnets": [
            {
                "available_ipv4_address_count": 251,
                "id": "xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
                "name": "snowdrop-subnet",
                "status": "available",
                "total_ipv4_address_count": 256,
                "zone": "eu-de-1"
            }
        ],
        "tags": []
    }
}

PLAY RECAP ***************************************************************************
localhost                  : ok=4    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

Thursday 21 October 2021  12:47:20 +0200 (0:00:00.047)       0:00:11.277 ******
===============================================================================
Get the vpc details ------------------------------------------ 10.19s
Gathering Facts ----------------------------------------------- 1.01s
Print VPC facts ----------------------------------------------- 0.05s
Fetch the variables from var file ----------------------------- 0.02s

Destroy an existing VPC

Destroy an existing VPC. This instruction also destroys:

  • VPC subnets

  • public gateway

$ ansible-playbook vpc-destroy.yml

Public Gateway

The VPC Create and VPC Destroy playbooks also create the related public gateway and attach it to the VPC subnet.

To get information on a Public Gateway use the pg-info.yml playbook.

e.g.

$ ansible-playbook pg-info.yml

PLAY [Display IBM Cloud Public Gateway information] *******************************************

TASK [Gathering Facts] ************************************************************************
Thursday 28 October 2021  10:45:10 +0200 (0:00:00.012)       0:00:00.012 ******
ok: [localhost]

TASK [Fetch the variables from var file] ******************************************************
Thursday 28 October 2021  10:45:11 +0200 (0:00:00.897)       0:00:00.909 ******
ok: [localhost]

TASK [Set static facts] ***********************************************************************
Thursday 28 October 2021  10:45:11 +0200 (0:00:00.020)       0:00:00.929 ******
ok: [localhost]

TASK [Get Public Gateway facts] ***************************************************************
Thursday 28 October 2021  10:45:11 +0200 (0:00:00.036)       0:00:00.965 ******
ok: [localhost]

TASK [Print Public Gateway facts] *************************************************************
Thursday 28 October 2021  10:45:17 +0200 (0:00:05.825)       0:00:06.791 ******

ok: [localhost] => {
    "msg": {
        "changed": false,
        "failed": false,
        "rc": 0,
        "resource": {
            "crn": "crn:v1:bluemix:public:is:eu-de-1:a/xxxxxxxxxxxxxxxxxxxxxxxx::public-gateway:xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
            "floating_ip": {
                "address": "158.177.4.17",
                "id": "xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx"
            },
            "id": "xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
            "name": "snowdrop-gateway",
            "resource_controller_url": "https://cloud.ibm.com/vpc-ext/network/publicGateways",
            "resource_crn": "crn:v1:bluemix:public:is:eu-de-1:a/xxxxxxxxxxxxxxxxxxxxxxxx::public-gateway:xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
            "resource_group": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "resource_group_name": "Default",
            "resource_name": "snowdrop-gateway",
            "resource_status": "available",
            "status": "available",
            "tags": [],
            "vpc": "xxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
            "zone": "eu-de-1"
        },
        "stderr": "",
        "stderr_lines": [],
        "stdout": "data.ibm_is_public_gateway.ansible_snowdropgateway: Refreshing state...\n\nWarning: Argument is deprecated\n\nThe generation field is deprecated and will be removed after couple of\nreleases\n\n\nApply complete! Resources: 0 added, 0 changed, 0 destroyed.\n",
        "stdout_lines": [
            "data.ibm_is_public_gateway.ansible_snowdropgateway: Refreshing state...",
            "",
            "Warning: Argument is deprecated",
            "",
            "The generation field is deprecated and will be removed after couple of",
            "releases",
            "",
            "",
            "Apply complete! Resources: 0 added, 0 changed, 0 destroyed."
        ]
    }
}

VSI - Virtual Server Instance

TODO