-
Notifications
You must be signed in to change notification settings - Fork 72
[Feature] [Platform] Install multi type support #1992
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 |
|---|---|---|
|
|
@@ -19,4 +19,6 @@ kustomize_test/ | |
| tools/codegen/boilerplate.go.txt | ||
|
|
||
| .checksum.code | ||
| .checksum.mod | ||
| .checksum.mod | ||
|
|
||
| cache/ | ||
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
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,87 @@ | ||
| --- | ||
| layout: page | ||
| parent: ArangoDBPlatform | ||
| title: Platform Installation File Schema | ||
| --- | ||
|
|
||
| # Installation Definition | ||
|
|
||
| ## Example | ||
|
|
||
| ```yaml | ||
| packages: | ||
| nginx: # OCI | ||
| chart: "oci://ghcr.io/nginx/charts/nginx-ingress:2.3.1" | ||
| version: 2.3.1 | ||
| prometheus: # Helm Index | ||
| chart: "index://prometheus-community.github.io/helm-charts" | ||
| version: 1.3.1 | ||
| alertmanager: # Remote Chart | ||
| chart: "https://github.com/prometheus-community/helm-charts/releases/download/alertmanager-0.1.0/alertmanager-0.1.0.tgz" | ||
| version: "0.1.0" | ||
| local: # Local File | ||
| chart: "file:///tmp/local-0.1.0.tgz" | ||
| version: "0.1.0" | ||
| inline: # Inline | ||
| chart: "<base64 string>" | ||
| version: "0.2.5" | ||
| platform: # Platform LicenseManager | ||
| version: v3.0.11 | ||
| ``` | ||
|
|
||
| ## Package | ||
|
|
||
| ### .package.packages.\<string\>.chart | ||
|
|
||
| Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/util/k8sutil/helm/package.go#L87)</sup> | ||
|
|
||
| Chart defines override of the PackageSpec | ||
| It supports multiple modes: | ||
| - If undefined, LicenseManager OCI Repository is used | ||
| - If starts with `file://` chart is fetched from local FileSystem | ||
| - If starts with `http://` or `https://` chart is fetched from the remote URL | ||
| - If starts with `index://` chart is fetched using Helm YAML Index File structure (using version and name) | ||
| - If Starts with `oci://` chart is fetched from Registry Compatible OCI Repository | ||
| - If none above match, chart is decoded using Base64 encoding | ||
|
|
||
| *** | ||
|
|
||
| ### .package.packages.\<string\>.overrides | ||
|
|
||
| Type: `Object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/util/k8sutil/helm/package.go#L91)</sup> | ||
|
|
||
| Overrides defines Values to override the Helm Chart Defaults (merged with Service Overrides) | ||
|
|
||
| *** | ||
|
|
||
| ### .package.packages.\<string\>.stage | ||
|
|
||
| Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/util/k8sutil/helm/package.go#L74)</sup> | ||
|
|
||
| Stage defines stage used in the fetch from LicenseManager | ||
|
|
||
| *** | ||
|
|
||
| ### .package.packages.\<string\>.version | ||
|
|
||
| Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/util/k8sutil/helm/package.go#L77)</sup> | ||
|
|
||
| Version keeps the version of the PackageSpec | ||
|
|
||
| *** | ||
|
|
||
| ### .package.releases.\<string\>.overrides | ||
|
|
||
| Type: `Object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/util/k8sutil/helm/package.go#L171)</sup> | ||
|
|
||
| Overrides defines Values to override the Helm Chart Defaults during installation | ||
|
|
||
| *** | ||
|
|
||
| ### .package.releases.\<string\>.package | ||
|
|
||
| Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.3.1/pkg/util/k8sutil/helm/package.go#L167)</sup> | ||
|
|
||
| Package keeps the name of the Chart used from the installation script. | ||
| References to value provided in Packages | ||
|
|
||
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
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
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
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
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.
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.
The same spelling inconsistency appears in the documentation: "If Starts with
oci://" should be "If starts withoci://" (lowercase 's' to match lines 42-43).