-
Notifications
You must be signed in to change notification settings - Fork 8
adding deploy external image docs #445
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
|
|
||
| # Deploy an External Image | ||
|
|
||
| This section of the documentation provides guidance on how to ***deploy an external image*** within the pipeline. | ||
|
|
||
| Deploying an external image directly allows you to bypass application and version configurations, offering flexibility for non-standardized services or third-party containers. The deployment process is straightforward and integrated into the UI. | ||
|
|
||
| To summarize, your workflow for deploying an external image is: | ||
|
|
||
| 1. **Prepare the external image**: Ensure it's built and pushed to a container registry accessible by the platform. | ||
|
|
||
| 2. **Access the `New deployment` dialog in the UI**: Select the option to deploy an external image from the menu. | ||
|
|
||
|  | ||
|
|
||
| 3. **Provide the external image uri and configure settings**: In the dialog, specify the image and adjust settings like resources, replicas, and public access. | ||
|
|
||
|  | ||
|
|
||
| ## External Image Reference | ||
|
|
||
| The external image reference specifies the image to deploy. It must include: | ||
|
|
||
| - The container registry (e.g., DockerHub, AWS ECR, GCR). | ||
| - The image name. | ||
| - The tag (e.g., `latest`, or a specific version like `1.2.3`). | ||
|
|
||
| Example external image reference: | ||
|
|
||
| ```plaintext | ||
| 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: | ||
|
|
||
| | Dialog Item | Description | | ||
| |----------------------|-----------------------------------------------------------------------------| | ||
| | **External Image** | The full external image reference, including registry, name, and tag. | | ||
| | **Environment Variables** | Any environment variables your container needs can be specified here. | | ||
| | **Deployment Settings** | Configure whether the image runs as a service or a job. Also, set CPU, memory, and replicas for scaling. | | ||
| | **Public Access** | Configure whether the container is accessible externally via a public URL. | | ||
| | **State Management** | If state is enabled, a `state` folder is created to persist data across restarts. See [state management docs](./state-management.md). | | ||
| | **Deployment Name** | The name of the deployment. You can change it to something descriptive. | | ||
|
|
||
| ## 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: | ||
|
|
||
| - **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). | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need a Yaml example?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am pointing to the yaml configuration here
quix-docs/docs/deploy/deploy-external-image.md
Line 53 in ac6a844