Protecting Cloud Databases resources with context-based restrictions

Creating network zones in the UI

1. Go to Manage > Context-based restrictions in the IBM Cloud® console.

2. Select Network zones.

3. Click Create.

4. Name your network zone and provide a description.

5. Enter your Allowed IP addresses. You can enter a single IP address, a range of IP addresses, or a single CIDR.

   The Denied IP addresses field is optional and should include only exceptions that are contained within the IP ranges you provide in the allowed IP addresses field.

6. Choose your Allowed VPCs, selecting as many as you like.

7. Reference a service: You can select Cloud Databases as a source service for context-based restrictions, but not as a target service. For example, you can provision a Cloud Databases instance using BYOK from IBM® Key Protect for IBM Cloud®. In this example, Cloud Databases is the source formation and IBM® Key Protect for IBM Cloud® is the target formation. Then, you would create a network zone with a Cloud Databases service reference and create a rule associated with the network zone that targets IBM® Key Protect for IBM Cloud®. To add a Cloud Databases service reference, for Service Type, IAM services is autoselected. In the Service dropdown, select a specific Cloud Databases service. If the zone you create is associated with a rule targeting Cloud Databases, then a service reference is not allowed.

Service references function only from Key Protect service to Cloud Databases.

Creating network zones in the CLI

To create network zones in the CLI, install the context-based restrictions CLI plug-in. Use the cbr-zone-create command to add resources to network zones. For more information, see the context-based restrictions CLI reference.

Create a zone by using a command like:

ibmcloud cbr zone-create --addresses=1.1.1.1,5.5.5.5 --name=<NAME>

Update a zone by using a command like:

ibmcloud cbr zone-update <ZONE-ID> --addresses=1.2.3.4 --name=<NAME>

Updating requires the ZONE-ID, not the zone name. Use the following command to list your zones and retrieve the relevant ZONE-ID:

ibmcloud cbr zones

The zone-update command is an overwrite. Include all of the fields that are required as if you are creating the rule from scratch. If you omit any required fields, the rule overwrites those missing fields as empty, and the rule might fail because some of those fields are required, regardless of whether they are changing the rule.

Delete a zone by using a command like:

ibmcloud cbr zone-delete <ZONE-ID>

Creating rules in the UI

1. Go to Manage > Context-based restrictions in the IBM Cloud® console.

2. Select Rules.

3. Click Create.

4. Select Specific APIs and then select Data plane. Any other selection results in an error.

   Cloud Databases does not currently support Control plane as an option.

5. Click Next.

6. Scope the rule to All resources or Specific resources. For more information, see Protecting Cloud Databases resources.

7. Click Continue.

8. Define the allowed endpoint types.

   • Keep the toggle set to No to allow all endpoint types.
   • Set the toggle to Yes to allow only specific endpoint types, then choose from the list.

9. Select a network zone or zones that you have already created, or create a new network zone by clicking Create.

   Contexts define from where your resources can be accessed, effectively linking your network zone to your rule.

10. Click Add to add your configuration to the summary.

11. Click Next.

12. Name your rule.

13. Select how you want to enforce the rule.

    Report-only is not available for Cloud Databases.

Creating rules in the CLI

To create rules in the CLI, install the context-based restrictions CLI plug-in.

To create a rule in the CLI, you need the appropriate Cloud Databases service_name:

• databases-for-etcd
• databases-for-elasticsearch
• databases-for-mongodb
• databases-for-postgresql
• databases-for-redis
• messages-for-rabbitmq
• databases-for-cassandra
• databases-for-enterprisedb
• database-for-mysql

Create a rule by using a command like:

ibmcloud cbr rule-create --enforcement-mode enabled --context-attributes "networkZoneId=<ZONE-ID>" --resource-group-id <RESOURCE_GROUP_ID> --service-name <SERVICE-NAME> --service-instance <SERVICE-INSTANCE> --api-types crn:v1:bluemix:public:context-based-restrictions::::api-type:data-plane --description <DESCRIPTION>

Cloud Databases does not currently support Control plane as an option.

Report-only is not available for Cloud Databases.

Update a rule by using a command like:

ibmcloud cbr rule-update <RULE-ID> --enforcement-mode disabled --context-attributes="networkZoneId=<ZONE-ID>" --resource-group-id   <RESOURCE_GROUP_ID> --service-name <SERVICE_NAME> --api-types crn:v1:bluemix:public:context-based-restrictions::::api-type:data-plane --description    <DESCRIPTION>

The rule-update command is an overwrite. Include all of the fields that are required as if you are creating the rule from scratch. If you omit any required fields, the rule overwrites those missing fields as empty, and the rule might fail because some of those fields are required, regardless of whether they are changing the rule.

Updating requires the RULE-ID, not the rule name. Use the following command to list your rules and retrieve the relevant RULE-ID:

ibmcloud cbr rules

Delete a rule by using a command like:

ibmcloud cbr rule-delete <RULE-ID>

Use ibmcloud cbr <command> — help for a full list of options and parameters. For example, ibmcloud cbr rule-create — help outputs parameters for rule creation.

Creating rules in Terraform

To create rules using Terraform, see IBM Cloud Provider in the Terraform Registry.

To create a rule, you need the appropriate Cloud Databases service_name:

• databases-for-etcd
• databases-for-elasticsearch
• databases-for-mongodb
• databases-for-postgresql
• databases-for-redis
• messages-for-rabbitmq
• databases-for-cassandra
• databases-for-enterprisedb
• database-for-mysql

The ibm_cbr_rule provides a resource for cbr_rule and allows a cbr_rule to be created, updated, and deleted.

Create a rule by using a command like:

resource "ibm_cbr_rule" "cbr_rule" {
  contexts {
        attributes {
            name = "networkZoneId"
            value = "559052eb8f43302824e7ae490c0281eb"
        }
        attributes {
               name = "endpointType"
               value = "private"
    }
  }
  description = "this is an example of a rule with one context one zone"
  enforcement_mode = "enabled"
  operations {
        api_types {
            api_type_id = "api_type_id"
        }
  }
  resources {
        attributes {
            name = "accountId"
            value = "12ab34cd56ef78ab90cd12ef34ab56cd"
        }
        attributes {
              name = "serviceName"
              value = "network-policy-enabled"
        }
        tags {
              name     = "tag_name"
              value    = "tag_value"
        }
  }
}

You can import the ibm_cbr_rule resource by using id, the globally unique ID of the rule.

terraform import ibm_cbr_rule.cbr_rule