Module registry: usage example

Switching to the Direct Mode

To switch an already running cluster to Direct mode, follow these steps:

1. Before switching, perform the migration to use the registry module.

2. Make sure the registry module is enabled and running. To do this, execute the following command:

   d8 k get module registry -o wide
   

   Example output:

   NAME       WEIGHT ...  PHASE   ENABLED   DISABLED MESSAGE   READY
   registry   38     ...  Ready   True                         True
   

3. Make sure all master nodes are in the Ready state and do not have the SchedulingDisabled status, using the following command:

   d8 k get nodes
   

   Example output:

   NAME       STATUS   ROLES                 ...
   master-0   Ready    control-plane,master  ...
   master-1   Ready    control-plane,master  ...
   master-2   Ready    control-plane,master  ...
   

   Example of output when the master node (master-2 in the example) is in the SchedulingDisabled status:

   NAME       STATUS                      ROLES                 ...
   master-0   Ready    control-plane,master  ...
   master-1   Ready    control-plane,master  ...
   master-2   Ready,SchedulingDisabled    control-plane,master  ...
   

4. Ensure the Deckhouse job queue is empty and contains no errors:

   d8 system queue list
   

   Example output:

   Summary:
   - 'main' queue: empty.
   - 107 other queues (0 active, 107 empty): 0 tasks.
   - no tasks to handle.
   

5. Set the Direct mode configuration in the ModuleConfig deckhouse. If you’re using a registry other than registry.deckhouse.io, refer to the deckhouse module documentation for correct configuration.

   Configuration example:

   apiVersion: deckhouse.io/v1alpha1
   kind: ModuleConfig
   metadata:
     name: deckhouse
   spec:
     version: 1
     enabled: true
     settings:
       registry:
         mode: Direct
         direct:
           imagesRepo: registry.deckhouse.io/deckhouse/ee
           scheme: HTTPS
           license: <LICENSE_KEY> # Replace with your license key
   

6. Check the registry switch status in the registry-state secret using this guide.

   Example output:

   conditions:
   # ...
     - lastTransitionTime: "..."
       message: ""
       reason: ""
       status: "True"
       type: Ready
   hash: ..
   mode: Direct
   target_mode: Direct
   

Switching to the Unmanaged Mode

To switch an already running cluster to Unmanaged mode, follow these steps:

1. Before switching, perform the migration to use the registry module.

2. Make sure the registry module is enabled and running. To do this, execute the following command:

   d8 k get module registry -o wide
   

   Example output:

   NAME       WEIGHT ...  PHASE   ENABLED   DISABLED MESSAGE   READY
   registry   38     ...  Ready   True                         True
   

3. Ensure the Deckhouse job queue is empty and contains no errors:

   d8 system queue list
   

   Example output:

   Summary:
   - 'main' queue: empty.
   - 107 other queues (0 active, 107 empty): 0 tasks.
   - no tasks to handle.
   

4. Set the Unmanaged mode configuration in the ModuleConfig deckhouse. If you’re using a registry other than registry.deckhouse.io, refer to the deckhouse module documentation for correct configuration.

   Configuration example:

   apiVersion: deckhouse.io/v1alpha1
   kind: ModuleConfig
   metadata:
     name: deckhouse
   spec:
     version: 1
     enabled: true
     settings:
       registry:
         mode: Unmanaged
         unmanaged:
           imagesRepo: registry.deckhouse.io/deckhouse/ee
           scheme: HTTPS
           license: <LICENSE_KEY> # Replace with your license key
   

5. Check the registry switch status in the registry-state secret using this guide.

   Example output:

   conditions:
   # ...
     - lastTransitionTime: "..."
       message: ""
       reason: ""
       status: "True"
       type: Ready
   hash: ..
   mode: Unmanaged
   target_mode: Unmanaged
   

6. If you need to switch back to the old registry management method, refer to the instruction.