Report Issue

OpenStack Management

We use OpenStack as our primary underlying cloud for CI. With the majority of the projects all hosted with the same vendor we can adopt common management pratices across them.

Sharing instance images

We can share CI images between projects. This is useful when it comes to bootstrapping a new project or when migrating a project to common-packer.

This process requires two different tenants to work with. The source tenant and the target tenant. We use $SOURCE and $TARGET to refer to the cloud names as defined in the clouds.yaml file for the source and target tenants.

  1. Get the project_id for the target tenant

    TARGET_ID=$(openstack token issue -c project_id -f value --os-cloud ${TARGET})
    

    $TARGET_ID is different from the actual tenant name.

  2. Get the image ID

    IMAGE_ID=$(openstack image list --private -f value --os-cloud ${SOURCE} | \
    grep "${NAME}" | cut -f1 -d' ')
    

    Where $NAME is the full name of the source image.

  3. Set the image visibility to shared (the default is private)

    openstack image set --shared ${IMAGE_ID} --os-cloud ${SOURCE}
    
  4. Share the image to target tenant

    openstack image add project ${IMAGE_ID} ${TARGET_ID} --os-cloud ${SOURCE}
    
  5. Accept the image share in the target tenant

    The image will not be visible until the target tenant accepts the image. Jenkins requires this to be able to see and use the image.

    openstack image set --accept ${IMAGE_ID} --os-cloud ${TARGET}
    

We perform the following to check that image is visible to the target tenant:

openstack image list --shared --os-cloud ${TARGET}

To reverse the share, we must first decide on making it permanent or temporary. To do a temporary reverse we can change the visibility of the image back to private:

openstack image set --private ${IMAGE_ID} --os-cloud ${SOURCE}

Doing this preserves the current share lists, but the image is no longer available to the downstream targets to consume. Set the image sharing to shared to re-enable downstream targets to consume the image.

The target can also stop accepting the image. There are two methods for doing this:

  1. Reject the share (thereby making it unavailable at all)

    openstack image set --reject ${IMAGE_ID} --os-cloud ${TARGET}
    
  2. Reset the share to a pending state, making it available if explicitly called, but invisible to the image listings (making it unavailable to Jenkins directly)

    openstack image set --pending ${IMAGE_ID} --os-cloud ${TARGET}
    

Remove access grants to tenants by doing the following:

openstack image remove project ${IMAGE_ID} ${TARGET_ID} --os-cloud ${SOURCE}