@@ -501,7 +501,7 @@ message StartContainerRequest {
501501 // Devices to be added to the container.
502502 repeated Device devices = 14 ;
503503
504- // Location describes where a resources (image, container, volume) is located.
504+ // Location describes where a container should be located.
505505 enum Location {
506506 L_UNKNOWN = 0 ;
507507
@@ -515,9 +515,25 @@ message StartContainerRequest {
515515 L_ALL = 3 ;
516516 }
517517
518- // location defines where a container should run. If a container is started on the backup, it is expected that any
519- // resources (image, volume, etc) be replicated to the backup prior to actually starting the container. This parameter
520- // cannot be updated, but rather the container needs to be removed and re-started with a new location value.
518+ // location defines where a container should run. If a container is started
519+ // on the backup, it is expected that any resources (image, volume, etc)
520+ // be replicated to the backup prior to actually starting the container.
521+ // This parameter cannot be updated, but rather the container needs to be
522+ // removed and re-started with a new location value.
523+ //
524+ // To further clarify the expected behaviour, we define to mode of operation:
525+ // - Single card mode: describes where only one supervisor card is
526+ // available.
527+ // - Dual card mode: describes when both the active and backup cards are
528+ // available.
529+ //
530+ // - Device is in dual mode: Containers should be placed according to the
531+ // location parameter.
532+ // - Device is in single mode: All containers should be running on the
533+ // remaining card.
534+ //
535+ // Containers started with the location set to ALL should only have one
536+ // instance if the device is in single mode.
521537 Location location = 15 ;
522538
523539 // Other container properties will be added as it becomes necessary.
0 commit comments