private registries (#482)

* adding private registries doc info

* adding link

* adding image examples

* splitting page

* improving doc

* adding private container registries to mkdocs

* changing size

* changing private container registries section

Author: emanuel-quix

docs/deploy/deploy-external-image.md

@@ -31,10 +31,6 @@ Example external image reference:
 dockerhub.io/myorg/my-service:1.2.3
 ```
 
-!!! tip
-
-    Ensure your external image is accessible from the platform. For private repositories, ensure the correct credentials or access policies are in place.
-
 ## Deployment Settings for External Images
 
 The deployment settings for external images are similar to application deployments, with slight differences. Below is a description of the main features:
@@ -50,9 +46,28 @@ The deployment settings for external images are similar to application deploymen
 
 ## Working on the Command Line
 
-To deploy an external image from the command line, modify your [`quix.yaml`](../quix-cli/yaml-reference/pipeline-descriptor.md) file to include the image, then use the following commands:
+To deploy an external image from the command line, modify your [`quix.yaml`](../quix-cli/yaml-reference/pipeline-descriptor.md) file to include the image. 
+
+Example:
+
+```yaml
+- name: custom-service
+    image: my-registry.com/my-service:1.2.3
+    deploymentType: Service
+    resources:
+      cpu: 300
+      memory: 600
+      replicas: 2
+    desiredStatus: Running
+```
+
+Then use the following commands:
 
 - **Sync local changes**: Use the `quix local pipeline sync --update` command. This updates your pipeline in Quix Cloud based on your `quix.yaml` file.
 - **Sync remote environment**: Use the `quix envs sync` command to synchronize an environment with its project repository.
 
 For more details on CLI usage, see the [CLI documentation](../quix-cli/overview.md).
+
+## Private Container Registries
+
+If the external image you wish to deploy is hosted in a private container registry, check out [this](./private-container-registries.md) page to learn how to configure it.

docs/deploy/private-container-registries.md

@@ -0,0 +1,37 @@
+# Private Container Registries
+
+The platform supports images hosted in private container registries for both scenarios:
+
+- **Using as a base image** in your Dockerfile for the build process.
+- **Deploying directly** as described [here](./deploy-external-image.md).
+
+In either case, you must configure the registry credentials on the platform to securely access the images during deployments.
+ 
+To configure these credentials, navigate to your organization's Settings page and locate the Container Registries section. Here, you can create, edit, and delete container registry configurations as needed.
+
+![Settings](../images/container-registies/container-registries-settings.png)
+
+## Required Information:
+
+![Create](../images/container-registies/container-registries-create.png){width=60%}
+
+Provide the following details when configuring credentials:
+
+| Field           | Description                                                                                           | Example                      |
+|-----------------|-------------------------------------------------------------------------------------------------------|------------------------------|
+| **Display Name**| A friendly name to easily identify your registry.                                                     | `My Org Private Registry`    |
+| **Address**     | The address of your registry.                                                                         | `my-registry.com`            |
+| **Auth Type**   | Authentication type. Supported values: `BasicAuth` or `Token`.                                        | `BasicAuth` or `Token`       |
+| **Credentials** | Depending on the authentication method selected:                                                      |                              |
+|                 | - **BasicAuth**: Provide a Username & Password                                                        | Username/password            |
+|                 | - **Token**: Provide a long-lived token                                                               | Token string                 |
+
+!!! warning
+
+    Ensure the credentials provided are long-lived, as the platform does not support automatic credential refresh.
+
+!!! note
+
+    If the image was deployed prior to configuring the credentials, you may need to restart the deployment for changes to take effect.
+
+More details about private registry authentication can be found [here](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/).

docs/images/container-registies/container-registries-create.png

@@ -292,6 +292,7 @@ nav:
         - 'State management': 'deploy/state-management.md'  
         - 'Deploy public services': 'deploy/deploy-public-page.md'
         - 'Deploy an external image': 'deploy/deploy-external-image.md'
+        - 'Private container registries': 'deploy/private-container-registries.md'
       - '4. Manage your pipelines':
         - 'Overview': 'manage/overview.md'
         - 'Troubleshooting': 'manage/troubleshooting.md'
@@ -319,7 +320,6 @@ nav:
       - 'Pipeline YAML (quix.yaml)': './quix-cli/yaml-reference/pipeline-descriptor.md'
       - 'Application YAML (app.yaml)': './quix-cli/yaml-reference/app-descriptor.md'
       - 'Docker Configuration (dockerfile)': './quix-cli/yaml-reference/dockerfile.md'
-
     - 'Security': 'quix-cloud/security.md'
     - 'Integrations':
       - 'Overview': 'integrations/overview.md'