Skip to content

Commit

Permalink
toolset
Browse files Browse the repository at this point in the history
  • Loading branch information
hilmarf committed Aug 15, 2024
1 parent 956cc93 commit b8d0832
Show file tree
Hide file tree
Showing 14 changed files with 20 additions and 23 deletions.
2 changes: 2 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ config
configfile
configs
consumerid
containerd
crd
creationtime
credentialrequest
Expand Down Expand Up @@ -256,6 +257,7 @@ templaters
templating
tgz
tls
todo
toi
toiexecutor
toolset
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

The Open Component Model (OCM) is an open standard to describe software bills of delivery (SBOD). OCM is a technology-agnostic and machine-readable format focused on the software artifacts that must be delivered for software products.

Check out the [the main OCM project web page](https://ocm.software) to find out what OCM offers you for implementing a secure software supply chain. It is your central entry point to all kind of OCM related [docs and guides](https://ocm.software/docs/overview/about), the [OCM specification](https://ocm.software/docs/overview/specification/) and all project [github repositories](https://github.com/open-component-model). It also offers a [Getting Started](https://ocm.software/docs/getting-started/) to quickly make your hands dirty with OCM, its tool set and concepts :smiley:
Check out the [the main OCM project web page](https://ocm.software) to find out what OCM offers you for implementing a secure software supply chain. It is your central entry point to all kind of OCM related [docs and guides](https://ocm.software/docs/overview/about), the [OCM specification](https://ocm.software/docs/overview/specification/) and all project [github repositories](https://github.com/open-component-model). It also offers a [Getting Started](https://ocm.software/docs/getting-started/) to quickly make your hands dirty with OCM, its toolset and concepts :smiley:

## OCM Specifications

Expand Down
2 changes: 1 addition & 1 deletion api/ocm/extensions/accessmethods/localblob/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ by registered blob handlers.

#### Provided Blob Handlers

The standard tool set uses the following registered blob handlers:
The standard toolset uses the following registered blob handlers:

- *Blob handler for importing oci artifact blobs into
an OCM repository mapped to an OCI registry*
Expand Down
2 changes: 1 addition & 1 deletion cmds/ocm/topics/common/credentials/topic.go
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ The general process for a credential management then looks as follows.
matching one based on the provided matching mechanism.
- it then returns the mapped credentials from the references repository.
The critical task for a user of the tool set is to define those assignments.
The critical task for a user of the toolset is to define those assignments.
This is basically a manual task, because the credentials stored in vault
(for example) could be usable for any kind of system, which typically
cannot be derived from the credential values.
Expand Down
4 changes: 2 additions & 2 deletions cmds/ocm/topics/toi/bootstrapping/topic.go
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ additionalResources:
name: config-file
`,
Long: `
TOI is a small tool set on top of the Open Component Model. It provides
TOI is a small toolset on top of the Open Component Model. It provides
a possibility to run images taken from a component version with user
configuration and feed them with the content of this component version.
It is some basic mechanism, which can be used to execute simple installation
Expand Down Expand Up @@ -455,7 +455,7 @@ files to logical outputs in the <code>outputs</code> section.
Basically the output may contain any data, but is strongly recommended
to use yaml or json files, only. This enables further formal processing
by the TOI tool set.
by the TOI toolset.
`,
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

TOI is a small tool set on top of the Open Component Model. It provides
TOI is a small toolset on top of the Open Component Model. It provides
a possibility to run images taken from a component version with user
configuration and feed them with the content of this component version.
It is some basic mechanism, which can be used to execute simple installation
Expand Down Expand Up @@ -397,7 +397,7 @@ files to logical outputs in the <code>outputs</code> section.

Basically the output may contain any data, but is strongly recommended
to use yaml or json files, only. This enables further formal processing
by the TOI tool set.
by the TOI toolset.

### Examples

Expand Down Expand Up @@ -464,4 +464,3 @@ additionalResources:
* [<b>ocm bootstrap package</b>](ocm_bootstrap_package.md) &mdash; bootstrap component version
* [<b>ocm bootstrap config</b>](ocm_bootstrap_config.md)
* [<b>ocm configfile</b>](ocm_configfile.md) &mdash; configuration file
5 changes: 2 additions & 3 deletions docs/reference/ocm_bootstrap_package_toi-bootstrapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

TOI is a small tool set on top of the Open Component Model. It provides
TOI is a small toolset on top of the Open Component Model. It provides
a possibility to run images taken from a component version with user
configuration and feed them with the content of this component version.
It is some basic mechanism, which can be used to execute simple installation
Expand Down Expand Up @@ -397,7 +397,7 @@ files to logical outputs in the <code>outputs</code> section.

Basically the output may contain any data, but is strongly recommended
to use yaml or json files, only. This enables further formal processing
by the TOI tool set.
by the TOI toolset.

### Examples

Expand Down Expand Up @@ -462,4 +462,3 @@ additionalResources:
* [<b>ocm bootstrap config</b>](ocm_bootstrap_config.md)
* [<b>ocm configfile</b>](ocm_configfile.md) &mdash; configuration file
3 changes: 1 addition & 2 deletions docs/reference/ocm_credential-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The general process for a credential management then looks as follows.
matching one based on the provided matching mechanism.
- it then returns the mapped credentials from the references repository.

The critical task for a user of the tool set is to define those assignments.
The critical task for a user of the toolset is to define those assignments.
This is basically a manual task, because the credentials stored in vault
(for example) could be usable for any kind of system, which typically
cannot be derived from the credential values.
Expand Down Expand Up @@ -383,4 +383,3 @@ The following types are currently available:
##### Additional Links

* [<b>ocm configfile</b>](ocm_configfile.md) &mdash; configuration file

5 changes: 2 additions & 3 deletions docs/reference/ocm_describe_package_toi-bootstrapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

TOI is a small tool set on top of the Open Component Model. It provides
TOI is a small toolset on top of the Open Component Model. It provides
a possibility to run images taken from a component version with user
configuration and feed them with the content of this component version.
It is some basic mechanism, which can be used to execute simple installation
Expand Down Expand Up @@ -397,7 +397,7 @@ files to logical outputs in the <code>outputs</code> section.

Basically the output may contain any data, but is strongly recommended
to use yaml or json files, only. This enables further formal processing
by the TOI tool set.
by the TOI toolset.

### Examples

Expand Down Expand Up @@ -464,4 +464,3 @@ additionalResources:
* [<b>ocm bootstrap package</b>](ocm_bootstrap_package.md) &mdash; bootstrap component version
* [<b>ocm bootstrap config</b>](ocm_bootstrap_config.md)
* [<b>ocm configfile</b>](ocm_configfile.md) &mdash; configuration file
5 changes: 2 additions & 3 deletions docs/reference/ocm_toi-bootstrapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### Description

TOI is a small tool set on top of the Open Component Model. It provides
TOI is a small toolset on top of the Open Component Model. It provides
a possibility to run images taken from a component version with user
configuration and feed them with the content of this component version.
It is some basic mechanism, which can be used to execute simple installation
Expand Down Expand Up @@ -397,7 +397,7 @@ files to logical outputs in the <code>outputs</code> section.

Basically the output may contain any data, but is strongly recommended
to use yaml or json files, only. This enables further formal processing
by the TOI tool set.
by the TOI toolset.

### Examples

Expand Down Expand Up @@ -462,4 +462,3 @@ additionalResources:
* [<b>ocm bootstrap package</b>](ocm_bootstrap_package.md) &mdash; bootstrap component version
* [<b>ocm bootstrap config</b>](ocm_bootstrap_config.md)
* [<b>ocm configfile</b>](ocm_configfile.md) &mdash; configuration file
2 changes: 1 addition & 1 deletion examples/lib/contexts.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Besides the standard sub packages, there are extension packages for

- `download`: Handlers understanding dedicated artifact and mime types
capable to provide then as filesystem content consumable by their
native tool set, for example Helm charts.
native toolset, for example Helm charts.

- `labels`: The handling of predefined label content.
- `valuemergehandler`: Merge algorithms used to support the merge
Expand Down
2 changes: 1 addition & 1 deletion examples/lib/tour/03-working-with-credentials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ the access method as credential consumer can access the blob.

### Providing credentials via credential repositories

The OCM tool set embraces multiple storage
The OCM toolset embraces multiple storage
backend technologies, for OCM metadata as well
as for artifacts described by a component version.
All those technologies typically have their own
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@ the access method as credential consumer can access the blob.

### Providing credentials via credential repositories

The OCM tool set embraces multiple storage
The OCM toolset embraces multiple storage
backend technologies, for OCM metadata as well
as for artifacts described by a component version.
All those technologies typically have their own
Expand Down
2 changes: 1 addition & 1 deletion examples/make/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ Flux can be used here.
The template projects is managed with *make*.
It can be used to create new versions (patch, minor, major)
and to build a component version that can later be
by the OCM tool set on the client side to import new
by the OCM toolset on the client side to import new
versions in a customer environment.

0 comments on commit b8d0832

Please sign in to comment.