@osaas/cli 4.5.0 → 4.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +5 -5
  2. package/readme.md +70 -23
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@osaas/cli",
3
- "version": "4.5.0",
3
+ "version": "4.6.0",
4
4
  "description": "Open Source Cloud CLI",
5
5
  "author": "Eyevinn Open Source Cloud <osc@eyevinn.se>",
6
6
  "homepage": "https://www.osaas.io",
@@ -24,10 +24,10 @@
24
24
  "dependencies": {
25
25
  "@osaas/client-ai": "^0.4.2",
26
26
  "@osaas/client-core": "^0.15.0",
27
- "@osaas/client-db": "^0.4.1",
27
+ "@osaas/client-db": "^0.4.2",
28
28
  "@osaas/client-intercom": "^0.2.2",
29
- "@osaas/client-transcode": "^0.13.3",
30
- "@osaas/client-web": "^0.3.0",
29
+ "@osaas/client-transcode": "^0.13.4",
30
+ "@osaas/client-web": "^0.3.1",
31
31
  "@types/promptly": "^3.0.5",
32
32
  "chalk": "4.1.2",
33
33
  "commander": "^12.1.0",
@@ -38,5 +38,5 @@
38
38
  "publishConfig": {
39
39
  "access": "public"
40
40
  },
41
- "gitHead": "66e8693b4c3a63556c8da544fdfdb1c243bbea82"
41
+ "gitHead": "f4d80dc7b9e7a0e65b3faef07422b33aaafa9b23"
42
42
  }
package/readme.md CHANGED
@@ -47,51 +47,98 @@ Commands:
47
47
 
48
48
  ## Examples
49
49
 
50
- ### List all my channel-engine instances
50
+ First set the environment variable `OSC_ACCESS_TOKEN` with your personal access token. Obtain the personal access token in the Eyevinn Open Source Cloud web console.
51
51
 
52
52
  ```
53
- % export OSC_ACCESS_TOKEN=<pat>
54
- % osc list channel-engine
53
+ % export OSC_ACCESS_TOKEN=<personal-access-token>
55
54
  ```
56
55
 
57
- ### Create a channel from a VOD on loop and insert ad breaks
56
+ ### Create a MinIO storage service and bucket
58
57
 
58
+ Create a MinIO storage server instance called `mystore` with the given credentials.
59
+
60
+ ```
61
+ % osc create minio-minio mystore -o RootUser=admin -o RootPassword=abC12345678
62
+ Instance created:
63
+ {
64
+ name: 'mystore',
65
+ url: 'https://eyevinnlab-mystore.minio-minio.auto.prod.osaas.io',
66
+ resources: {
67
+ license: { url: 'https://api-minio-minio.auto.prod.osaas.io/license' },
68
+ app: {
69
+ url: 'https://eyevinnlab-mystore.minio-minio.auto.prod.osaas.io/'
70
+ }
71
+ },
72
+ RootUser: 'admin',
73
+ RootPassword: 'abC12345678'
74
+ }
75
+ ```
76
+
77
+ Install the MinIO client to create a bucket on this server. If you already have MinIO client installed you can skip this step.
78
+
79
+ ```
80
+ % brew install minio/stable/mc
59
81
  ```
60
- % osc create channel-engine cli -o \
61
- type=Loop \
62
- url=https://lab.cdn.eyevinn.technology/stswetvplus-promo-2023-5GBm231Mkz.mov/manifest.m3u8 \
63
- opts.useDemuxedAudio=false \
64
- opts.useVttSubtitles=false \
65
- opts.preroll.url=http://maitv-vod.lab.eyevinn.technology/VINN.mp4/master.m3u8 \
66
- opts.preroll.duration=10500
82
+
83
+ Setup an alias to your server. Replace the URL below with the instance URL returned when created the store.
84
+
85
+ ```
86
+ % mc alias set mystore https://eyevinnlab-mystore.minio-minio.auto.prod.osaas.io admin abC12345678
67
87
  ```
68
88
 
69
- ### Remove a channel-engine instance with name `clidemo`
89
+ Create a bucket called `mybucket`
70
90
 
71
91
  ```
72
- % osc remove channel-engine clidemo
92
+ % mc mb mystore/mybucket
93
+ Bucket created successfully `mystore/mybucket`.
73
94
  ```
74
95
 
75
- ### Create ABR files for VOD using SVT Encore
96
+ To access the bucket using the AWS S3 client:
76
97
 
77
98
  ```
78
- osc encore create test s3://lab-testcontent-store/birme/
79
- osc encore transcode https://testcontent.eyevinn.technology/mp4/stswe-tvplus-promo.mp4
99
+ % AWS_ACCESS_KEY_ID=admin AWS_SECRET_ACCESS_KEY=abC12345678 \
100
+ aws s3 --endpoint=https://eyevinnlab-mystore.minio-minio.auto.prod.osaas.io \
101
+ cp images.jpeg s3://mybucket/
102
+ upload: images.jpeg to s3://mybucket/images.jpeg
103
+ % AWS_ACCESS_KEY_ID=admin AWS_SECRET_ACCESS_KEY=abC12345678 \
104
+ aws s3 --endpoint=https://eyevinnlab-mystore.minio-minio.auto.prod.osaas.io \
105
+ ls s3://mybucket/
106
+ 2025-01-21 10:35:11 12533 images.jpeg
80
107
  ```
81
108
 
82
- ### Transcode and create streaming package using SVT Encore and Shaka Packager
109
+ ### List all my MinIO storage services
83
110
 
84
111
  ```
85
- osc pipeline create s3://lab-testcontent-store/birme/output/
86
- osc pipeline transcode https://testcontent.eyevinn.technology/mp4/stswe-tvplus-promo.mp4
112
+ % osc list minio-minio
87
113
  ```
88
114
 
89
- ### Compare two video files using VMAF
115
+ ### Enable CDN for access to MinIO bucket
116
+
117
+ Allow public read access to bucket.
118
+
119
+ ```
120
+ % mc anonymous set download mystore/mybucket
121
+ ```
122
+
123
+ Setup CDN property in AWS Cloudfront
124
+
125
+ ```
126
+ % osc web cdn-create --provider=cloudfront --origin-path=/mybucket minio-minio mystore
127
+ ```
128
+
129
+ ### Remove a MinIO storage bucket
130
+
131
+ ```
132
+ % osc remove minio-minio mystore
133
+ Are you sure you want to remove mystore? (yes/no) yes
134
+ ```
135
+
136
+ ### Create ABR file for VOD using SVT Encore
137
+
138
+ Create a VOD file for streaming from using a pipeline named `demo`. Follow the steps in the [Eyevinn Open Source Cloud documentation](https://docs.osaas.io/osaas.wiki/Solution%3A-VOD-Transcoding.html#vod-transcoding-and-packaging) on how to setup a pipeline.
90
139
 
91
140
  ```
92
- % osc compare vmaf s3://lab-testcontent-store/birme/snaxax_x264_3100.mp4 \
93
- s3://lab-testcontent-store/birme/snaxax_x264_324.mp4 \
94
- s3://lab-testcontent-store/birme/
141
+ % osc vod create demo https://testcontent.eyevinn.technology/mp4/VINN.mp4
95
142
  ```
96
143
 
97
144
  ### List all channel-engine instance for tenant `eyevinn` as an OSC super admin