diff --git a/docs/README.md b/docs/README.md index ec3f6dfed..643032931 100644 --- a/docs/README.md +++ b/docs/README.md @@ -53,7 +53,6 @@ - [Performance Analysis](technical/performance.md) - [Scaling of Landscaper Pods](technical/scaling.md) - [Target Types](technical/target_types.md) -- [Types](technical/types.md) ## Usage diff --git a/docs/deployer/helm.md b/docs/deployer/helm.md index 5afab8e63..c8ae1e977 100644 --- a/docs/deployer/helm.md +++ b/docs/deployer/helm.md @@ -300,7 +300,7 @@ component: version: 'v0.1.0' ... resources: - - type: helm.io/chart + - type: helmChart name: nginx-chart version: 9.7.0 relation: external diff --git a/docs/guided-tour/blueprints/echo-server/config-files/components.yaml b/docs/guided-tour/blueprints/echo-server/config-files/components.yaml index 5d640c215..5a5217359 100644 --- a/docs/guided-tour/blueprints/echo-server/config-files/components.yaml +++ b/docs/guided-tour/blueprints/echo-server/config-files/components.yaml @@ -11,7 +11,7 @@ components: type: ociArtifact imageReference: eu.gcr.io/gardener-project/landscaper/examples/blueprints/guided-tour/echo-server:1.0.0 - name: echo-server-chart - type: helm.io/chart + type: helmChart version: 1.0.0 access: type: ociArtifact diff --git a/docs/guided-tour/blueprints/echo-server/config-files/local-blob-components.yaml b/docs/guided-tour/blueprints/echo-server/config-files/local-blob-components.yaml index 616b61c38..dfe86fdf3 100644 --- a/docs/guided-tour/blueprints/echo-server/config-files/local-blob-components.yaml +++ b/docs/guided-tour/blueprints/echo-server/config-files/local-blob-components.yaml @@ -12,7 +12,7 @@ components: compress: true mediaType: application/vnd.gardener.landscaper.blueprint.v1+tar+gzip - name: echo-server-chart - type: helm.io/chart + type: helmChart input: type: file path: ../chart/echo-server-1.0.0.tgz diff --git a/docs/guided-tour/blueprints/helm-chart-resource/README.md b/docs/guided-tour/blueprints/helm-chart-resource/README.md index 2451f4907..a53b4247b 100644 --- a/docs/guided-tour/blueprints/helm-chart-resource/README.md +++ b/docs/guided-tour/blueprints/helm-chart-resource/README.md @@ -52,7 +52,7 @@ components: # notice that this has to be a reference to the updated blueprint imageReference: eu.gcr.io/gardener-project/landscaper/examples/blueprints/guided-tour/helm-chart-resource:1.0.0 - name: helm-chart - type: helm.io/chart + type: helmChart version: 1.0.0 access: type: ociArtifact @@ -77,7 +77,7 @@ components: # notice that this has to be a reference to the updated blueprint imageReference: eu.gcr.io/gardener-project/landscaper/examples/blueprints/guided-tour/helm-chart-resource:1.0.0 - name: helm-chart - type: helm.io/chart + type: helmChart version: 1.0.0 access: type: helm diff --git a/docs/guided-tour/blueprints/helm-chart-resource/config-files/components.yaml b/docs/guided-tour/blueprints/helm-chart-resource/config-files/components.yaml index c99215549..2eacff696 100644 --- a/docs/guided-tour/blueprints/helm-chart-resource/config-files/components.yaml +++ b/docs/guided-tour/blueprints/helm-chart-resource/config-files/components.yaml @@ -13,7 +13,7 @@ components: type: ociArtifact imageReference: eu.gcr.io/gardener-project/landscaper/examples/blueprints/guided-tour/helm-chart-resource:1.0.0 - name: helm-chart - type: helm.io/chart + type: helmChart version: 1.0.0 access: type: ociArtifact diff --git a/docs/guided-tour/blueprints/helm-chart-resource/config-files/local-blob-components.yaml b/docs/guided-tour/blueprints/helm-chart-resource/config-files/local-blob-components.yaml index 2fd1fb1ba..42a3ef00e 100644 --- a/docs/guided-tour/blueprints/helm-chart-resource/config-files/local-blob-components.yaml +++ b/docs/guided-tour/blueprints/helm-chart-resource/config-files/local-blob-components.yaml @@ -14,7 +14,7 @@ components: compress: true mediaType: application/vnd.gardener.landscaper.blueprint.v1+tar+gzip - name: helm-chart - type: helm.io/chart + type: helmChart input: type: file path: ../../../hello-world/chart/hello-world-1.0.0.tgz diff --git a/docs/guided-tour/import-export/import-parameters/component-descriptor.yaml b/docs/guided-tour/import-export/import-parameters/component-descriptor.yaml index 6c77009a3..19b70d3d7 100644 --- a/docs/guided-tour/import-export/import-parameters/component-descriptor.yaml +++ b/docs/guided-tour/import-export/import-parameters/component-descriptor.yaml @@ -23,7 +23,7 @@ component: type: ociRegistry imageReference: eu.gcr.io/gardener-project/landscaper/examples/blueprints/guided-tour/echo-server:1.1.0 - name: echo-server-chart - type: helm.io/chart + type: helmChart version: 1.0.0 relation: external access: diff --git a/docs/technical/types.md b/docs/technical/types.md deleted file mode 100644 index 4963abab4..000000000 --- a/docs/technical/types.md +++ /dev/null @@ -1,189 +0,0 @@ -# Types - -This documents the resource and media type that are used by the landscaper and some deployers. - -For known target types see [target types](./target_types.md) - -Resource type refer to the type defined in a component descriptor. - -**Index**: -- [Blueprints](#blueprints) -- [JSON Schema](#json-schema) -- Deployer - - [Helm Chart](#helm-chart) - -### Blueprints - - - - - - - - - -
ResourceType landscaper.gardener.cloud/blueprint (deprecated blueprint)
Access - localFilesystemBlob: -
    -
  • DEPRECATED:application/vnd.gardener.landscaper.blueprint.v1+tar+gzip
    • -
  • application/vnd.gardener.landscaper.blueprint.layer.v1.tar+gzip
    • -
-
- Standalone Artifact (ociRegistry):
- Config
- application/vnd.gardener.landscaper.blueprint.config.v1+yaml
- One Layer (the compression is optional) -
    -
  • DEPRECATED:application/vnd.gardener.landscaper.blueprint.v1+tar+gzip
    • -
  • application/vnd.gardener.landscaper.blueprint.layer.v1.tar+gzip
    • -
-
- -**LocalBlob**: - -If the blueprint is stored as local blob - -_Example_: -```yaml -resources: -- name: my-blueprint - type: landscaper.gardener.cloud/blueprint - access: - type: localFilesystemBlob - filename: my-bloc - mediaType: application/vnd.gardener.landscaper.blueprint.layer.v1.tar+gzip -``` - -A blueprint blob is expected to be a gzipped tar that MUST contains the `blueprint.yaml` at the root. - -**Standalone Artifact**: - -The OCI manifest of the Blueprint in this case would look like this: -Whereas the config is contains the `blueprint.yaml`. -```json -{ - "mediaType": "application/vnd.docker.distribution.manifest.v2+json", - "schemaVersion": 2, - "config": { - "digest": "sha256:efg", - "mediaType": "application/vnd.gardener.landscaper.blueprint.config.v1+yaml" - }, - "layers": [ - { - "digest": "sha256:efg", - "mediaType": "application/vnd.gardener.landscaper.blueprint.layer.v1.tar+gzip" - } - ] -} -``` - -```yaml -resources: -- name: my-blueprint - type: landscaper.gardener.cloud/blueprint - access: - type: ociRegistry - imageReference: -``` - -### JSON Schema - - - - - - - - - - -
ResourceType landscaper.gardener.cloud/jsonschema
Access - localFilesystemBlob: -
    -
  • DEPRECATED: application/vnd.gardener.landscaper.jsonscheme.v1+json
    • -
  • application/vnd.gardener.landscaper.jsonschema.layer.v1.json
    • -
- Standalone Artifact (ociRegistry): not yet implemented -
- -**LocalBlob**: - -the jsonschema blob is expected to be a stored as plain json of type `application/vnd.gardener.landscaper.jsonscheme.v1+json` - -_Example_: -```yaml -resources: -- name: my-schema - type: landscaper.gardener.cloud/jsonschema - access: - type: localFilesystemBlob - filename: my-bloc - mediaType: application/vnd.gardener.landscaper.jsonschema.layer.v1.json -``` - - -## Deployer - -### Helm Chart - - - - - - - - - -
ResourceType helm.io/chart (deprecated helm)
Access - localFilesystemBlob: application/tar+gzip
- Standalone Artifact (ociRegistry): oci artifact with a config containing the Chart.yaml one layer of type application/tar+gzip -
- -**LocalBlob**: - -If the blueprint is stored as local blob - -_Example_: -```yaml -resources: -- name: my-helm-chart - type: helm.io/chart - access: - type: localFilesystemBlob - filename: my-bloc - mediaType: application/tar+gzip -``` - -A blueprint blob is expected to be a gzipped tar that MUST contains the `blueprint.yaml` at the root. - -**Standalone Artifact**: - -The helm deployer supports the default oci helm cartifact as created by the helm cli. -For more information about the usage see the official [helm docs](https://helm.sh/docs/topics/registries/#where-are-my-charts) - -```json -{ - "schemaVersion": 2, - "config": { - "mediaType": "application/vnd.cncf.helm.config.v1+json", - "digest": "sha256:8ec7c0f2f6860037c19b54c3cfbab48d9b4b21b485a93d87b64690fdb68c2111", - "size": 117 - }, - "layers": [ - { - "mediaType": "application/tar+gzip", - "digest": "sha256:1b251d38cfe948dfc0a5745b7af5ca574ecb61e52aed10b19039db39af6e1617", - "size": 2487 - } - ] -} -``` - -```yaml -resources: -- name: my-helm-chart - type: helm.io/chart - access: - type: ociRegistry - imageReference: -```