-
Notifications
You must be signed in to change notification settings - Fork 39
docs: Update Prepare User Data and Argument files and Build Edge Artifacts DOC-1822 #9520
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
Open
StacySpectro
wants to merge
12
commits into
master
Choose a base branch
from
DOC-1822
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
6ad1084
Clarify sentence
StacySpectro 9da6d68
Update user-data and arg information
StacySpectro 5becc1c
Fixed partials and more edits
StacySpectro ddf134d
Merge branch 'master' into DOC-1822
StacySpectro 15c525e
ci: auto-formatting prettier issues
StacySpectro 442071e
Small formatting tweak
StacySpectro 7b96b34
ci: auto-formatting prettier issues
StacySpectro 4a5b775
Fix broken links
StacySpectro ffa3edb
A couple of more tweaks
StacySpectro 09358f5
ci: auto-formatting prettier issues
StacySpectro e8b6fdc
Update lanaguage
StacySpectro 717f3be
Add forgotten formatting
StacySpectro 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,34 @@ | ||
| --- | ||
| partial_category: palette-edge-canvos-version | ||
| partial_name: canvos-edge-arg-file | ||
| --- | ||
|
|
||
| Specify the system architecture, OS distribution, and version. These configurations apply to your Edge host's OS both before and after cluster formation. | ||
|
|
||
| <li>Specify the Kubernetes distribution and version. This is used with the OS distribution and version to create an immutable provider image with your specified OS and Kubernetes. </li> | ||
|
|
||
| :::info | ||
|
|
||
| To build multiple versions of a provider image with different Kubernetes versions, use the `k8s_version.json` file in the repository. You must leave the `K8S_VERSION` field in your `.arg` file empty to use the JSON file. This file is only used when `K8S_VERSION` is not detected as an argument. | ||
|
|
||
| ::: | ||
|
|
||
| <li>Specify the image registry, image repository name, and custom tag for your provider images. The custom tag, together with the Palette agent version (the same number as the Git tag you are using), the version and distribution of Kubernetes, and the OS used by the image forms the tag of the image.</li> | ||
|
|
||
|
|
||
| For example, if your `.arg` file contains the following arguments, the full image reference would be | ||
| `ttl.sh/ubuntu:k3s-1.33.5-v4.8.5-demo`. | ||
|
|
||
| ```text | ||
| IMAGE_REGISTRY=ttl.sh | ||
| IMAGE_REPO=ubuntu | ||
| CUSTOM_TAG=demo | ||
| K8S_DISTRIBUTION=k3s | ||
| K8S_VERSION=1.33.5 | ||
| OS_DISTRIBUTION=ubuntu | ||
| OS_VERSION=22 | ||
| ``` | ||
|
|
||
| The `.arg` file uses the default values for any remaining arguments. Refer to [Edge Artifact Build Configurations](./arg) for all available `.arg` configuration parameters. | ||
|
|
||
| Using the arguments defined in the `.arg` file, the final provider images you generate will have the following naming convention, `[IMAGE_REGISTRY]/[IMAGE_REPO]:[CUSTOM_TAG]`. For example, one of the provider images might be `spectrocloud/ubuntu:k3s-1.33.5-v4.8.5-palette-learn`. |
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,20 @@ | ||
| --- | ||
| partial_category: palette-edge-canvos-version | ||
| partial_name: canvos-edge-user-data | ||
| --- | ||
|
|
||
| From the CanvOS directory, copy the **user-data.template** file and name the copy **user-data**. Edit the `user-data` file to include the following fields under `stylus.site`. | ||
| - edgeHostToken | ||
| - paletteEndpoint | ||
| - projectName | ||
StacySpectro marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| The `user-data` file uses the `cloud-init` `cloud-config` format. The first line of your file must be `#cloud-config` to ensure that `cloud-init` recognizes and applies the configuration correctly. | ||
|
|
||
| ```shell | ||
| #cloud-config | ||
| stylus: | ||
| site: | ||
| ... | ||
| ``` | ||
| Refer to [Cloud Init Stages](./clusters/edge/edge-configuration/cloud-init/) and the [Edge Installer Configuration Reference](./clusters/edge/edge-configuration/installer-reference/) for supported keys and stages. | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.