Skip to content

Commit d504c76

Browse files
Manoj PaladiyaManoj Paladiya
authored andcommitted
Update readme for v1.20.0 release
Signed-off-by: Manoj Paladiya <[email protected]>
1 parent 522c9b8 commit d504c76

File tree

3 files changed

+71
-25
lines changed

3 files changed

+71
-25
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,14 @@ There are two ways to obtain the plugin
3535

3636
### Download from IBM container registry
3737

38-
The plugin is also provided in a container image `cp.icr.io/cpopen/cpfs/ibm-pak:TAG` where `TAG` should be replaced with the corresponding plugin version, for example `cp.icr.io/cpopen/cpfs/ibm-pak:v1.19.1` will have `v1.19.1` of the plugin.
38+
The plugin is also provided in a container image `cp.icr.io/cpopen/cpfs/ibm-pak:TAG` where `TAG` should be replaced with the corresponding plugin version, for example `cp.icr.io/cpopen/cpfs/ibm-pak:v1.20.0` will have `v1.20.0` of the plugin.
3939

4040
The following command will create a container and copy the plug-ins for all the supported platforms in a directory, `plugin-dir`. You can specify any directory name and it will be created while copying. After copying, it will delete the temporary container. The `plugin-dir` will have all the binaries and other artifacts you find in a Github release and repo at [IBM/ibm-pak](https://github.com/IBM/ibm-pak). For example,
4141

4242
1. If you use docker:
4343

4444
```
45-
id=$(docker create cp.icr.io/cpopen/cpfs/ibm-pak:v1.19.1 - )
45+
id=$(docker create cp.icr.io/cpopen/cpfs/ibm-pak:v1.20.0 - )
4646
docker cp $id:/ibm-pak-plugin plugin-dir
4747
docker rm -v $id
4848
cd plugin-dir
@@ -51,7 +51,7 @@ cd plugin-dir
5151
2. If you podman:
5252

5353
```
54-
id=$(podman create cp.icr.io/cpopen/cpfs/ibm-pak:v1.19.1 - )
54+
id=$(podman create cp.icr.io/cpopen/cpfs/ibm-pak:v1.20.0 - )
5555
podman cp $id:/ibm-pak-plugin plugin-dir
5656
podman rm -v $id
5757
cd plugin-dir

docs/command-help.md

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,7 @@ Flags:
386386
387387
-h, --help help for get
388388
--install-method string Install method to generate manifests as per install type. One of: [OLM, helm] (default "OLM")
389+
--resolve-unique-dependencies if provided, check for duplicate versions and resolve exact one suitable version of sub-CASE (optional)
389390
--skip-dependencies skip downloading dependencies (optional)
390391
--skip-verify if provided, skips the certification verification (optional)
391392
--version string the "semantic version range" specifying the CASE to download, e.g. '2.0.0' or '>=1.0.0, <=3.0.0' (optional - assumes latest if not provided)
@@ -424,6 +425,11 @@ Example:
424425
oc ibm-pak get ibm-my-cloudpak --version 1.0.0 --install-method helm
425426
```
426427

428+
- Download a CASE with unique sub-CASE version (most suitable) when multiple versions of sub-CASE found (Supported with ibm-pak version `v1.20.0` or higher)
429+
```
430+
oc ibm-pak get ibm-my-cloudpak --version 1.0.0 --resolve-unique-dependencies
431+
```
432+
427433
# ibm-pak generate mirror-manifests
428434
Generate mirror manifests for a CASE
429435

@@ -637,10 +643,14 @@ Usage:
637643
oc ibm-pak list
638644
639645
Flags:
640-
--case-name string print the list of all CASE images (separately printed for each version) matching the given case name
641-
--downloaded print the list of downloaded CASE images available locally
642-
-h, --help help for list
643-
-o, --output string Specify output format as json, yaml or ""
646+
--case-name string print the list of all CASE images (separately printed for each version) matching the given case name
647+
--case-version string list helm charts of given CASE
648+
--chart-name string list helm charts versions of given chart
649+
--chart-repo string Chart repository
650+
--charts list helm charts available in provided repository or downloaded locally
651+
--downloaded print the list of downloaded CASE images available locally
652+
-h, --help help for list
653+
-o, --output string Specify output format as json, yaml or ""
644654
```
645655

646656
Example:
@@ -686,6 +696,42 @@ Example:
686696
oc ibm-pak list --case-name ibm-my-cloudpak --downloaded -o yaml
687697
```
688698

699+
- List all Charts available in the provided chart repository (Supported with ibm-pak version `v1.20.0` or higher)
700+
```
701+
oc ibm-pak list --charts --chart-repo https://github.com/IBM/charts/raw/master/repo/ibm-helm/
702+
```
703+
704+
- List all Charts in json output (Supported with ibm-pak version `v1.20.0` or higher)
705+
```
706+
oc ibm-pak list --charts --chart-repo https://github.com/IBM/charts/raw/master/repo/ibm-helm/ -o json
707+
```
708+
709+
- List all Charts in yaml output (Supported with ibm-pak version `v1.20.0` or higher)
710+
```
711+
oc ibm-pak list --charts --chart-repo https://github.com/IBM/charts/raw/master/repo/ibm-helm/ -o yaml
712+
```
713+
714+
- List all versions of Chart for a specific chart name (Supported with ibm-pak version `v1.20.0` or higher)
715+
```
716+
oc ibm-pak list --charts --chart-name ibm-appconnect-operator --chart-repo https://github.com/IBM/charts/raw/master/repo/ibm-helm/
717+
```
718+
719+
- List all downloaded Charts from ibm-pak workspace (Supported with ibm-pak version `v1.20.0` or higher)
720+
```
721+
oc ibm-pak list --charts --downloaded
722+
```
723+
724+
- List all downloaded Charts for a CASE (Supported with ibm-pak version `v1.20.0` or higher)
725+
```
726+
oc ibm-pak list --charts --case-name ibm-cert-manager --downloaded
727+
```
728+
729+
- List all downloaded Charts for a CASE for specific version (Supported with ibm-pak version `v1.20.0` or higher)
730+
```
731+
oc ibm-pak list --charts --case-name ibm-cert-manager --case-version 4.2.15 --downloaded
732+
```
733+
734+
689735
# ibm-pak verify
690736
Verify the integrity of downloaded CASEs
691737

docs/download-github.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,72 +21,72 @@
2121
Example using `curl`:
2222

2323
```
24-
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-darwin-amd64.tar.gz -o oc-ibm_pak-darwin-amd64.tar.gz
25-
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-darwin-amd64.tar.gz.sig -o oc-ibm_pak-darwin-amd64.tar.gz.sig
24+
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-darwin-amd64.tar.gz -o oc-ibm_pak-darwin-amd64.tar.gz
25+
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-darwin-amd64.tar.gz.sig -o oc-ibm_pak-darwin-amd64.tar.gz.sig
2626
```
2727

2828
Example using `wget`:
2929

3030
```
31-
wget https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-darwin-amd64.tar.gz
32-
wget https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-darwin-amd64.tar.gz.sig
31+
wget https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-darwin-amd64.tar.gz
32+
wget https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-darwin-amd64.tar.gz.sig
3333
```
3434

3535
## Linux x86-architecture
3636

3737
Example using `curl`:
3838

3939
```
40-
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-linux-amd64.tar.gz -o oc-ibm_pak-linux-amd64.tar.gz
41-
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-linux-amd64.tar.gz.sig -o oc-ibm_pak-linux-amd64.tar.gz.sig
40+
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-linux-amd64.tar.gz -o oc-ibm_pak-linux-amd64.tar.gz
41+
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-linux-amd64.tar.gz.sig -o oc-ibm_pak-linux-amd64.tar.gz.sig
4242
```
4343

4444
Example using `wget`:
4545

4646
```
47-
wget https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-linux-amd64.tar.gz
48-
wget https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-linux-amd64.tar.gz.sig
47+
wget https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-linux-amd64.tar.gz
48+
wget https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-linux-amd64.tar.gz.sig
4949
```
5050

5151
## Linux ppc64le-architecture
5252

5353
Example using `curl`:
5454

5555
```
56-
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-linux-ppc64le.tar.gz -o oc-ibm_pak-linux-ppc64le.tar.gz
57-
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-linux-ppc64le.tar.gz.sig -o oc-ibm_pak-linux-ppc64le.tar.gz.sig
56+
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-linux-ppc64le.tar.gz -o oc-ibm_pak-linux-ppc64le.tar.gz
57+
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-linux-ppc64le.tar.gz.sig -o oc-ibm_pak-linux-ppc64le.tar.gz.sig
5858
```
5959

6060
Example using `wget`:
6161

6262
```
63-
wget https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-linux-ppc64le.tar.gz
64-
wget https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-linux-ppc64le.tar.gz.sig
63+
wget https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-linux-ppc64le.tar.gz
64+
wget https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-linux-ppc64le.tar.gz.sig
6565
```
6666

6767
## Linux s390x-architecture
6868

6969
Example using `curl`:
7070

7171
```
72-
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-linux-s390x.tar.gz -o oc-ibm_pak-linux-s390x.tar.gz
73-
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-linux-s390x.tar.gz.sig -o oc-ibm_pak-linux-s390x.tar.gz.sig
72+
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-linux-s390x.tar.gz -o oc-ibm_pak-linux-s390x.tar.gz
73+
curl -L https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-linux-s390x.tar.gz.sig -o oc-ibm_pak-linux-s390x.tar.gz.sig
7474
```
7575

7676
Example using `wget`:
7777

7878
```
79-
wget https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-linux-s390x.tar.gz
80-
wget https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-linux-s390x.tar.gz.sig
79+
wget https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-linux-s390x.tar.gz
80+
wget https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-linux-s390x.tar.gz.sig
8181
```
8282

8383
## Windows
8484

8585
Example (from PowerShell) using `curl`:
8686

8787
```
88-
curl https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-windows-amd64.tar.gz -o oc-ibm_pak-windows-amd64.tar.gz
89-
curl https://github.com/IBM/ibm-pak/releases/download/v1.19.1/oc-ibm_pak-windows-amd64.tar.gz.sig -o oc-ibm_pak-windows-amd64.tar.gz.sig
88+
curl https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-windows-amd64.tar.gz -o oc-ibm_pak-windows-amd64.tar.gz
89+
curl https://github.com/IBM/ibm-pak/releases/download/v1.20.0/oc-ibm_pak-windows-amd64.tar.gz.sig -o oc-ibm_pak-windows-amd64.tar.gz.sig
9090
```
9191

9292
# Download public keys for ibm-pak versions less than v1.5.0

0 commit comments

Comments
 (0)