As the vSphere administrator responsible for managing VIC, I want my colleagues to be warned not to perform operations on VCH appliances or container VMs using the vSphere Client or vSphere Web Client. They may not be reading the VIC documentation thoroughly.
As a vSphere administrator, I want to be reminded not to perform operations on VCH appliances or container VMs using the vSphere Client or vSphere Web Client. I may not remember all warnings I read in the VIC documentation.
As a reader of the VIC documentation, I want to be able to focus on the core concepts being explained, without being distracted by off-topic "IMPORTANT" warnings.
As a reader of the VIC documentation, I want "IMPORTANT" warnings to be reserved for truly important messages so that I do not become desensitized to their presence.
IMPORTANT: Do not use the vSphere Client or vSphere Web Client to perform operations on VCH appliances or container VMs. Specifically, using the vSphere Client or vSphere Web Client to power off, power on, or delete VCH appliances or container VMs can cause vSphere Integrated Containers Engine to not function correctly. Always use vic-machine to perform operations on VCHs. Always use Docker commands to perform operations on containers.
It would be good to warn users who are about to perform a dangerous operation, instead of relying on them to read and remember warnings in the documentation.
This can be done by creating and registering a tiny extension to manage the ManagedBy field on objects VIC manages. Here's an example of a warning generated by a similar extension (registered by vCloud Director):
Despite being a relatively minor UX change (more text in an existing confirmation dialog), this can be an effective way to reduce the frequency of issues related to direct management of entities in the vSphere web client, and can streamline the documentation.
Acceptance Criteria:
Users are shown a warning when they attempt to perform a dangerous operation on a VIC-managed entity using the vSphere Client or vSphere Web Client.
The documentation is updated to de-emphasize and de-duplicate the repetitive warning.
Additional details as necessary:
It would, of course, be better for VIC to be resilient to changes made through the vSphere Client and vSphere Web Client. This would make adoption of VIC by vSphere administrators a more intuitive and less painful process. This issue moves the warning to a place it is more likely to be seen; resiliency removes the need for the warning altogether, allowing users to manage workloads the way they are used to.
dougm
commented
6 years ago
User Statement:
As the vSphere administrator responsible for managing VIC, I want my colleagues to be warned not to perform operations on VCH appliances or container VMs using the vSphere Client or vSphere Web Client. They may not be reading the VIC documentation thoroughly.
As a vSphere administrator, I want to be reminded not to perform operations on VCH appliances or container VMs using the vSphere Client or vSphere Web Client. I may not remember all warnings I read in the VIC documentation.
As a reader of the VIC documentation, I want to be able to focus on the core concepts being explained, without being distracted by off-topic "IMPORTANT" warnings.
As a reader of the VIC documentation, I want "IMPORTANT" warnings to be reserved for truly important messages so that I do not become desensitized to their presence.
Details:
Currently, the documentation includes warnings like:
It would be good to warn users who are about to perform a dangerous operation, instead of relying on them to read and remember warnings in the documentation.
This can be done by creating and registering a tiny extension to manage the
ManagedByfield on objects VIC manages. Here's an example of a warning generated by a similar extension (registered by vCloud Director):Despite being a relatively minor UX change (more text in an existing confirmation dialog), this can be an effective way to reduce the frequency of issues related to direct management of entities in the vSphere web client, and can streamline the documentation.
Acceptance Criteria:
Users are shown a warning when they attempt to perform a dangerous operation on a VIC-managed entity using the vSphere Client or vSphere Web Client.
The documentation is updated to de-emphasize and de-duplicate the repetitive warning.
Additional details as necessary:
It would, of course, be better for VIC to be resilient to changes made through the vSphere Client and vSphere Web Client. This would make adoption of VIC by vSphere administrators a more intuitive and less painful process. This issue moves the warning to a place it is more likely to be seen; resiliency removes the need for the warning altogether, allowing users to manage workloads the way they are used to.