Skip to content

Commit

Permalink
Change spec layout on website (#203)
Browse files Browse the repository at this point in the history
## Description

change components.yaml to component-constructor.yaml
  • Loading branch information
morri-son authored Mar 17, 2024
1 parent 299dc35 commit e0b2b0f
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions content/en/docs/cli-reference/add/add_componentversions.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ isCommand: true
### Usage

```
ocm add componentversions [<options>] [--version <version>] [<ctf archive>] {<components.yaml>}
ocm add componentversions [<options>] [--version <version>] [<ctf archive>] {<component-constructor.yaml>}
```

### Options
Expand Down Expand Up @@ -152,9 +152,9 @@ script with the <code>script</code> option family.

```
$ ocm add componentversions --file ctf --version 1.0 components.yaml
$ ocm add componentversions --file ctf --version 1.0 component-constructor.yaml
and a file <code>components.yaml</code>:
and a file <code>component-constructor.yaml</code>:
name: ocm.software/demo/test
version: 1.0.0
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/guides/best-practices-with-ocm.md
Original file line number Diff line number Diff line change
Expand Up @@ -734,7 +734,7 @@ COMMIT: 5f03021059c7dbe760ac820a014a8a84166ef8b4
```

```shell
ocm add componentversions --create --file ../gen/ctf --settings ../gen/dynamic_settings.yaml --settings static_settings.yaml components.yaml
ocm add componentversions --create --file ../gen/ctf --settings ../gen/dynamic_settings.yaml --settings static_settings.yaml component-constructor.yaml
```

## Debugging: Explain the blobs directory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,8 @@ components:
With the components modeled we can start to build a component archive using the `ocm` cli:

```
ocm add componentversions --create --file component-archive components.yaml
processing components.yaml...
ocm add componentversions --create --file component-archive component-constructor.yaml
processing component-constructor.yaml...
processing document 1...
processing index 1
processing index 2
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/guides/getting-started-with-ocm.md
Original file line number Diff line number Diff line change
Expand Up @@ -545,7 +545,7 @@ The previous steps can be combined into a single operation working on a single d
The command [ocm add componentversions](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_add_componentversions.md)
directly creates or extends a common transport archive without the need for creating dedicated component archives

Create a yaml configuration file `components.yaml`, which contains information about the components
Create a yaml configuration file `component-constructor.yaml`, which contains information about the components
to create and the elements addded to those components

```yaml
Expand All @@ -569,11 +569,11 @@ components:
```

```shell
ocm add componentversions --create --file ${CTF_ARCHIVE} components.yaml
ocm add componentversions --create --file ${CTF_ARCHIVE} component-constructor.yaml
```

```shell
processing components.yaml...
processing component-constructor.yaml...
processing document 1...
processing index 1
found 1 component
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/guides/structuring-software-with-ocm.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,15 +114,15 @@ Example:
helm repo add bitnami https://charts.bitnami.com/bitnami
helm pull --destination . bitnami/mariadb
```
The helm chart for mariadb is then stored in the current working directory as `mariadb:11.4.5.tgz` and can be referenced as path from there in the `components.yaml` file (see below).
The helm chart for mariadb is then stored in the current working directory as `mariadb:11.4.5.tgz` and can be referenced as path from there in the `component-constructor.yaml` file (see below).

The helm chart for the microblog application is our own and part of the source code. It is
not downloaded from a public repository.


### Input Specification

The corresponding input file for building the component version (`components.yaml`) will then look like this:
The corresponding input file for building the component version (`component-constructor.yaml`) will then look like this:

```yaml
components:
Expand Down Expand Up @@ -253,7 +253,7 @@ Note the differences between the various components:

### Building the Common Transport Archive

From the input file `components.yaml` the common transport archive can be created with the
From the input file `component-constructor.yaml` the common transport archive can be created with the
OCM CLI. For all variables we need to provide values. Variable values can be passed in the
command line or stored in a file. For many variable having a values file is more convenient.
The corresponding file `settings.yaml` may look like this:
Expand All @@ -274,7 +274,7 @@ NGINX_CHART_VERSION: 4.4.2
Create the transport archive then with:
```shell
ocm add componentversions --create --file <ctf-target-dir> --settings settings.yaml components.yaml
ocm add componentversions --create --file <ctf-target-dir> --settings settings.yaml component-constructor.yaml
```

You can view the generated component descriptor using the command:
Expand Down

0 comments on commit e0b2b0f

Please sign in to comment.