[specific ci=Group23-VIC-Machine-Service] container-name-convention support added to vic-machine API

[AngieCris]

Fixes #6503

container-name-convention support is now added to vic-machine create API and inspect API.

Details

1. vic-machine create API
   POST request body includes a container object that specifies the configurations for containers on the VCH such as network, CPU, memory (not implemented yet). Within container field, name_convention field is a string that specifies a naming convention for vSphere display names for containers.
   name_convention must contain either {id} or {name} as token (including both tokens in naming convention is currently not supported).
   For example, if the naming convention is container-{id} and there's a container running on the VCH, the vSphere display name for this container would be container-short_id where short_id is the short ID of that container.
   Note that this only changes the display names of containers on vSphere, not actual Docker container names.

An example of vic-machine create API request body:

{
	"name": "vch-test-1",
	"storage":{
		"image_stores":["ds://datastore1"]
	},
	"network":{
		"bridge":{
			"ip_range":"172.16.0.0/12",
			"port_group":{"name":"bridge"}
		},
		"public":{
			"port_group":{"name":"vm-network"}
		},
	},
	"auth":{
		"no_tls":true
	},
	"container": {
                "name_convention":"container-{id}"
        }
}

2. vic-machine inspect API
   The response body of POST request now includes a field name_convention field under container of type string that specifies the vSphere display naming convention for containers running on the VCH.

Example vic-machine inspect GET response body:

{
  "auth": {
    "client": {
      "certificate_authorities": []
    }
  },
  "compute": {
    "cpu": {
      "shares": {
        "level": "normal"
      }
    },
    "memory": {
      "shares": {
        "level": "normal"
      }
    },
    "resource": {
      "id": "resgroup-v35"
    }
  },
  "container":{
      "name_convention": "container-{id}",
  },
  "endpoint": {
    "cpu": {
      "sockets": 1
    },
    "memory": {
      "units": "MiB",
      "value": 2048
    },
    "operations_credentials": {}
  },
  "name": "vch-test-1",
  "network": {
    "bridge": {
      "ip_range": "172.16.0.0/12",
      "port_group": {
        "id": "dvportgroup-23"
      }
    },
    "client": {
      "nameservers": [],
      "port_group": {
        "id": "dvportgroup-22"
      }
    },
    "container": [],
    "management": {
      "nameservers": [],
      "port_group": {
        "id": "dvportgroup-21"
      }
    },
    "public": {
      "nameservers": [],
      "port_group": {
        "id": "dvportgroup-22"
      }
    }
  },
  "registry": {
    "blacklist": null,
    "certificate_authorities": [],
    "insecure": [],
    "whitelist": []
  },
  "runtime": {
    "admin_portal": "https://10.160.213.153:2378",
    "docker_host": "10.160.213.153:2375",
    "power_state": "poweredOn",
    "upgrade_status": "Up to date"
  },
  "storage": {
    "base_image_size": {
      "units": "KiB",
      "value": 8000000
    },
    "image_stores": [
      "ds://datastore1/vch-test-1"
    ],
    "volume_stores": []
  },
  "version": "v1.2.0-rc1-0-a3b3132"
}

Remaining work
In integration test, verify container naming convention with docker

[anchal-agrawal]

Could we simply do this here?

if vchConfig.ContainerNameConvention != "" {
    model.ContainerNameConvention = vchConfig.ContainerNameConvention
}

[zjs]

Based on the comments in vic-machine/common/container.go, it seems like we expect more container-related properties to be added in the future:

		// other container flags to to added"
		// default container memory
		// default container cpu
		// default container network

Given that, I think this should probably be structured along the lines of the following to give us more flexibility to eventually represent those properties as a part of this JSON structure:

"container": {
    "type": "object",
    "properties": {
        "name_convention": {
            "type": "string",
            "pattern": "^.*(\\{id\\}|\\{name\\}).*"
        }
    }
}

[AngieCris]

good point, thanks

[zjs]

lgtm

[mdharamadas1]

@AngieCris #6527 is closed which this PR is referring to for adding integration tests. Does that mean we need to add tests as part of this then for scenarios covered here?

[AngieCris]

@mdharamadas1 adding tests for this functionality now, will let you know when it's done

[zjs]

Looks good!

[AngieCris]

Currently the integration test only verifies of inspect output contains the container naming convention supplied when creating the specific VCH.
Still pending a more complicated integration test that involves checking vSphere display name of container with docker, and docker regression test.
Using docker in VIC machine API integration tests will be captured later in separate issues.

[mdharamadas1]

lgtm