MVP Testcase Definition for OCM CLI #8

In-Ko · 2022-07-18T07:57:12Z

In-Ko
Jul 18, 2022
Maintainer

One of the next issues we need to work on is the definition of an MVP Testcase for the OCM Client. For this, the following questions need to be answered:

How does a typical OCM-CLI usage look like ?
What is the starting point of a typical scenario, what is the desired goal ?
Which steps need to be done to reach that goal ?
Which commands need to be executed, and in which sequence ?

Maybe it is a good idea to gather all ideas / suggestions here.

jensh007 · 2022-07-18T08:49:52Z

jensh007
Jul 18, 2022
Maintainer

Suggest to come up with some basic scenarios to get started. https://github.com/jensh007/ocm-example-hello is a first try in this direction. May be we can derive some test cases out of this.

0 replies

Skarlso · 2022-07-18T10:54:15Z

Skarlso
Jul 18, 2022
Maintainer

I need some actually working examples that are implemented with OCM right now. I think that's mostly local things and OciReg maybe, right?

0 replies

Skarlso · 2022-07-18T11:19:29Z

Skarlso
Jul 18, 2022
Maintainer

I'm trying out this scenario right now:

- create a component
    `ocm create componentarchive skarlso.test/ 0.0.1 skarlso test-ocm`
- add some resources and sources to the component
- package the component
- make a transfer of the component
- ????
- profit
- get and list sources and resources for the component
- see if signing can be made to work

It's a bit cumbersome as there are no documents but the reference guides for the CLI. But I think I get by. :)

1 reply

Skarlso Jul 18, 2022
Maintainer

Balazs will write a nice little Markdown doc about all the things we found during this exploration.

yitsushi · 2022-07-21T09:17:20Z

yitsushi
Jul 21, 2022

The logic I tried to follow:

I want to create a component (create componentarchive).
I want to add resources to that component (add resources).
I want to download all references resources for offline usage.
I want to create an immutable CD with my component.
I want to bring my immutable CD to my Fenced environment
I expect all resources are bundled in my component on the CD, so I can deploy
them without internet access.

I have this resource file:

# ef_test/hello-worls-component.yaml
name: 'hello-world'
version: '1.0.7'
type: 'ociImage'
relation: 'external'
access:
  type: 'ociRegistry'
  imageReference: 'ghcr.io/yitsushi/hello-world:1.0.7'

4 replies

yitsushi Jul 21, 2022

Commands I issued:

./ocm create componentarchive efertone.dev/ 0.0.1 efertone efertone-package
./ocm add resources efertone-package ef_test/hello-worls-component.yaml

# At this point I tried to download resources, but the download command only
# downloads the oci image as an independent .tar.gz archive.
./ocm download resources efertone-package -O efertone-package/hello-world.tar.gz


❯ tree efertone-package
efertone-package
├── blobs
├── component-descriptor.yaml
└── hello-world.tar.gz

1 directory, 2 files

❯ tar tzf efertone-package/hello-world.tar.gz
artefact-descriptor.json
blobs
blobs/sha256.2f97e43aea52dede928ccd2e1bcd75325b157bd2d5e893e3cd179e6eb5de1488
blobs/sha256.5305f40ab0c9c75856e5ffe193f47253e53696305f0da5ec44dacadec342328d
blobs/sha256.92360c1eaf0032a860dddb1e3cdc16b27bdfec509c23de434dbe53d3d35bed9d
blobs/sha256.df9b9388f04ad6279a7410b85cedfdcb2208c0a003da7ab5613af71079148139

If I extract the downloaded .tar.gz archive into efertone-package/, then I
get this directory structre:

❯ tree efertone-package
efertone-package
├── artefact-descriptor.json
├── blobs
│   ├── sha256.2f97e43aea52dede928ccd2e1bcd75325b157bd2d5e893e3cd179e6eb5de1488
│   ├── sha256.5305f40ab0c9c75856e5ffe193f47253e53696305f0da5ec44dacadec342328d
│   ├── sha256.92360c1eaf0032a860dddb1e3cdc16b27bdfec509c23de434dbe53d3d35bed9d
│   └── sha256.df9b9388f04ad6279a7410b85cedfdcb2208c0a003da7ab5613af71079148139
├── component-descriptor.yaml
└── hello-world.tar.gz

1 directory, 7 files

I don't know if it's the desired state or not, but this logic will fail as soon
as I have two resources defined because when I extract the second archive, it
will overwrite the artefact-descriptor.json file and
component-descriptor.yaml still wouldn't have any references to those sha256
blobs.

I tried to find a command that would do that for me properly, but I couldn't
find one.

yitsushi Jul 21, 2022

Create CTF

./ocm create transportarchive ./efertone-package-transport
./ocm transfer componentarchive efertone-package efertone-package-transport

❯ tree efertone-package-transport
efertone-package-transport
├── artefact-index.json
└── blobs
    ├── sha256.6238b31c7c8431ed8190a7fd2b6df6b7d28e2625f0b75b29b955a88d2456f096
    ├── sha256.a641af9ad43e1e7459db0e6ca853930dc768cedc5419d5987e4db9c77b9e16db
    └── sha256.ee6b2345a7972d2c3dc49ee92a79d78a98db6fa7be0ecaaaf94f759f750b093d

1 directory, 4 files

❯ file efertone-package-transport/blobs/*
efertone-package-transport/blobs/sha256.6238b31c7c8431ed8190a7fd2b6df6b7d28e2625f0b75b29b955a88d2456f096: POSIX tar archive
efertone-package-transport/blobs/sha256.a641af9ad43e1e7459db0e6ca853930dc768cedc5419d5987e4db9c77b9e16db: JSON text data
efertone-package-transport/blobs/sha256.ee6b2345a7972d2c3dc49ee92a79d78a98db6fa7be0ecaaaf94f759f750b093d: JSON text data

❯ cat efertone-package-transport/blobs/sha256.6238b31c7c8431ed8190a7fd2b6df6b7d28e2625f0b75b29b955a88d2456f096
component-descriptor.yaml0000000000000000000000000000053714163714600014277 0ustar0000000000000000component:
  componentReferences: []
  name: efertone.dev/
  provider: efertone
  repositoryContexts: []
  resources:
  - access:
      imageReference: ghcr.io/yitsushi/hello-world:1.0.7
      type: ociRegistry
    name: hello-world
    relation: external
    type: ociImage
    version: 1.0.7
  sources: []
  version: 0.0.1
meta:
  schemaVersion: v2

❯ cat efertone-package-transport/blobs/sha256.a641af9ad43e1e7459db0e6ca853930dc768cedc5419d5987e4db9c77b9e16db
{"componentDescriptorLayer":{"mediaType":"application/vnd.gardener.cloud.cnudie.component-descriptor.v2+yaml+tar","digest":"sha256:6238b31c7c8431ed8190a7fd2b6df6b7d28e2625f0b75b29b955a88d2456f096","size":2048}}%

❯ cat efertone-package-transport/blobs/sha256.ee6b2345a7972d2c3dc49ee92a79d78a98db6fa7be0ecaaaf94f759f750b093d
{"schemaVersion":2,"mediaType":"application/vnd.oci.image.manifest.v1+json","config":{"mediaType":"application/vnd.gardener.cloud.cnudie.component.config.v1+json","digest":"sha256:a641af9ad43e1e7459db0e6ca853930dc768cedc5419d5987e4db9c77b9e16db","size":210},"layers":[{"mediaType":"application/vnd.gardener.cloud.cnudie.component-descriptor.v2+yaml+tar","digest":"sha256:6238b31c7c8431ed8190a7fd2b6df6b7d28e2625f0b75b29b955a88d2456f096","size":2048}]}%

Try as `.tar.gz`

❯ tar tzf efertone-package/hello-world.tar.gz
artefact-descriptor.json
blobs
blobs/sha256.2f97e43aea52dede928ccd2e1bcd75325b157bd2d5e893e3cd179e6eb5de1488
blobs/sha256.5305f40ab0c9c75856e5ffe193f47253e53696305f0da5ec44dacadec342328d
blobs/sha256.92360c1eaf0032a860dddb1e3cdc16b27bdfec509c23de434dbe53d3d35bed9d
blobs/sha256.df9b9388f04ad6279a7410b85cedfdcb2208c0a003da7ab5613af71079148139

❯ ./ocm oci artefacts transfer --repo tgz::efertone-package/hello-world.tar.gz efertone-package-transport
Error: all mode not support

Try as directory

❯ mkdir ef_test/hello-world
❯ tar zxf efertone-package/hello-world.tar.gz -C ef_test/hello-world
❯ tree ef_test/hello-world
ef_test/hello-world
├── artefact-descriptor.json
└── blobs
    ├── sha256.2f97e43aea52dede928ccd2e1bcd75325b157bd2d5e893e3cd179e6eb5de1488
    ├── sha256.5305f40ab0c9c75856e5ffe193f47253e53696305f0da5ec44dacadec342328d
    ├── sha256.92360c1eaf0032a860dddb1e3cdc16b27bdfec509c23de434dbe53d3d35bed9d
    └── sha256.df9b9388f04ad6279a7410b85cedfdcb2208c0a003da7ab5613af71079148139

1 directory, 5 files

❯ ./ocm oci artefacts transfer --repo "directory::ef_test/hello-world"  efertone-package-transport
Error: all mode not support

Try without `--repo`

❯ ./ocm oci artefacts transfer ./ef_test/hello-world  ./efertone-package-transport
copying :1.0.7 to :1.0.7...
copied 1 from 1 artefact(s)

❯ tree efertone-package-transport
efertone-package-transport
├── artefact-index.json
└── blobs
    ├── sha256.2f97e43aea52dede928ccd2e1bcd75325b157bd2d5e893e3cd179e6eb5de1488
    ├── sha256.5305f40ab0c9c75856e5ffe193f47253e53696305f0da5ec44dacadec342328d
    ├── sha256.6238b31c7c8431ed8190a7fd2b6df6b7d28e2625f0b75b29b955a88d2456f096
    ├── sha256.92360c1eaf0032a860dddb1e3cdc16b27bdfec509c23de434dbe53d3d35bed9d
    ├── sha256.a641af9ad43e1e7459db0e6ca853930dc768cedc5419d5987e4db9c77b9e16db
    ├── sha256.df9b9388f04ad6279a7410b85cedfdcb2208c0a003da7ab5613af71079148139
    └── sha256.ee6b2345a7972d2c3dc49ee92a79d78a98db6fa7be0ecaaaf94f759f750b093d

1 directory, 8 files

❯ find ./ef_test/hello-world  -name 'sha256*' \
    | xargs -I {} bash \
      -c 'hash=$(basename {}); \
         if find ./efertone-package-transport/blobs -name $hash ''| grep . > /dev/null; \
         then echo "ok: $hash"; \
         else echo "!!! not found: ${hash}"; \
         fi'
ok: sha256.2f97e43aea52dede928ccd2e1bcd75325b157bd2d5e893e3cd179e6eb5de1488
ok: sha256.5305f40ab0c9c75856e5ffe193f47253e53696305f0da5ec44dacadec342328d
ok: sha256.92360c1eaf0032a860dddb1e3cdc16b27bdfec509c23de434dbe53d3d35bed9d
ok: sha256.df9b9388f04ad6279a7410b85cedfdcb2208c0a003da7ab5613af71079148139

yitsushi Jul 21, 2022

Try again with `.tar.gz` without `--repo`

❯ ./ocm create transportarchive ./efertone-package-transport2
❯ ./ocm transfer componentarchive efertone-package efertone-package-transport2
transferring version "efertone.dev/:0.0.1"...
...adding component version...

❯ ./ocm oci artefacts transfer ./efertone-package/hello-world.tar.gz  ./efertone-package-transport2
copying :1.0.7 to :1.0.7...
copied 1 from 1 artefact(s)

❯ find ./ef_test/hello-world  -name 'sha256*' \
    | xargs -I {} bash \
      -c 'hash=$(basename {}); \
         if find ./efertone-package-transport/blobs -name $hash ''| grep . > /dev/null; \
         then echo "ok: $hash"; \
         else echo "!!! not found: ${hash}"; \
         fi'
ok: sha256.2f97e43aea52dede928ccd2e1bcd75325b157bd2d5e893e3cd179e6eb5de1488
ok: sha256.5305f40ab0c9c75856e5ffe193f47253e53696305f0da5ec44dacadec342328d
ok: sha256.92360c1eaf0032a860dddb1e3cdc16b27bdfec509c23de434dbe53d3d35bed9d
ok: sha256.df9b9388f04ad6279a7410b85cedfdcb2208c0a003da7ab5613af71079148139

yitsushi Jul 21, 2022

So if I understand correctly

download artefacts for component (ocm download resources)
create ctf (ocm create transportarchive)
transfer component (can be remote) (ocm transfer componentarchive)
repeat: transfer artefact (can be remote, local works jut fine) (ocm oci artefacts transfer)
done

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MVP Testcase Definition for OCM CLI #8

{{title}}

Replies: 4 comments 5 replies

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

MVP Testcase Definition for OCM CLI #8

In-Ko Jul 18, 2022 Maintainer

Replies: 4 comments · 5 replies

jensh007 Jul 18, 2022 Maintainer

Skarlso Jul 18, 2022 Maintainer

Skarlso Jul 18, 2022 Maintainer

Skarlso Jul 18, 2022 Maintainer

yitsushi Jul 21, 2022

yitsushi Jul 21, 2022

yitsushi Jul 21, 2022

Create CTF

Try as .tar.gz

Try as directory

Try without --repo

yitsushi Jul 21, 2022

Try again with .tar.gz without --repo

yitsushi Jul 21, 2022

So if I understand correctly

In-Ko
Jul 18, 2022
Maintainer

Replies: 4 comments 5 replies

jensh007
Jul 18, 2022
Maintainer

Skarlso
Jul 18, 2022
Maintainer

Skarlso
Jul 18, 2022
Maintainer

Skarlso Jul 18, 2022
Maintainer

yitsushi
Jul 21, 2022

Try as `.tar.gz`

Try without `--repo`

Try again with `.tar.gz` without `--repo`