uffizzi-cli 1.0.5 → 2.0.27

Sign up to get free protection for your applications and to get access to all the features.
Files changed (156) hide show
  1. checksums.yaml +4 -4
  2. data/config/uffizzi.rb +1 -0
  3. data/lib/uffizzi/auth_helper.rb +13 -5
  4. data/lib/uffizzi/cli/account.rb +122 -0
  5. data/lib/uffizzi/cli/cluster.rb +363 -0
  6. data/lib/uffizzi/cli/common.rb +2 -4
  7. data/lib/uffizzi/cli/config.rb +5 -4
  8. data/lib/uffizzi/cli/connect.rb +14 -8
  9. data/lib/uffizzi/cli/disconnect.rb +1 -1
  10. data/lib/uffizzi/cli/login.rb +130 -66
  11. data/lib/uffizzi/cli/login_by_identity_token.rb +11 -7
  12. data/lib/uffizzi/cli/preview/service.rb +1 -1
  13. data/lib/uffizzi/cli/preview.rb +33 -32
  14. data/lib/uffizzi/cli/project.rb +17 -9
  15. data/lib/uffizzi/cli.rb +46 -7
  16. data/lib/uffizzi/clients/api/api_client.rb +92 -2
  17. data/lib/uffizzi/clients/api/api_routes.rb +44 -0
  18. data/lib/uffizzi/clients/api/http_client.rb +19 -7
  19. data/lib/uffizzi/config_file.rb +15 -40
  20. data/lib/uffizzi/error.rb +15 -0
  21. data/lib/uffizzi/helpers/config_helper.rb +49 -0
  22. data/lib/uffizzi/helpers/file_helper.rb +25 -0
  23. data/lib/uffizzi/helpers/login_helper.rb +33 -0
  24. data/lib/uffizzi/helpers/project_helper.rb +19 -0
  25. data/lib/uffizzi/promt.rb +4 -0
  26. data/lib/uffizzi/response_helper.rb +33 -14
  27. data/lib/uffizzi/services/cluster_service.rb +59 -0
  28. data/lib/uffizzi/services/compose_file_service.rb +5 -4
  29. data/lib/uffizzi/services/env_variables_service.rb +1 -1
  30. data/lib/uffizzi/services/github_service.rb +21 -0
  31. data/lib/uffizzi/services/kubeconfig_service.rb +132 -0
  32. data/lib/uffizzi/services/preview_service.rb +52 -18
  33. data/lib/uffizzi/shell.rb +19 -16
  34. data/lib/uffizzi/token.rb +37 -0
  35. data/lib/uffizzi/version.rb +1 -1
  36. data/lib/uffizzi.rb +10 -0
  37. data/man/uffizzi +7 -5
  38. data/man/uffizzi-account +29 -0
  39. data/man/uffizzi-account-list +26 -0
  40. data/man/uffizzi-account-list.html +103 -0
  41. data/man/uffizzi-account-list.ronn +19 -0
  42. data/man/uffizzi-account-set-default +29 -0
  43. data/man/uffizzi-account-set-default.html +105 -0
  44. data/man/uffizzi-account-set-default.ronn +22 -0
  45. data/man/uffizzi-account.html +106 -0
  46. data/man/uffizzi-account.ronn +23 -0
  47. data/man/uffizzi-cluster +37 -0
  48. data/man/uffizzi-cluster-create +49 -0
  49. data/man/uffizzi-cluster-create.ronn +41 -0
  50. data/man/uffizzi-cluster-delete +32 -0
  51. data/man/uffizzi-cluster-delete.ronn +24 -0
  52. data/man/uffizzi-cluster-describe +39 -0
  53. data/man/uffizzi-cluster-describe.ronn +30 -0
  54. data/man/uffizzi-cluster-list +34 -0
  55. data/man/uffizzi-cluster-list.ronn +26 -0
  56. data/man/uffizzi-cluster-update-kubeconfig +37 -0
  57. data/man/uffizzi-cluster-update-kubeconfig.ronn +29 -0
  58. data/man/uffizzi-cluster.ronn +32 -0
  59. data/man/uffizzi-compose +39 -0
  60. data/man/uffizzi-compose-create +67 -0
  61. data/man/uffizzi-compose-create.ronn +57 -0
  62. data/man/uffizzi-compose-delete +38 -0
  63. data/man/uffizzi-compose-delete.ronn +29 -0
  64. data/man/uffizzi-compose-describe +38 -0
  65. data/man/uffizzi-compose-describe.ronn +29 -0
  66. data/man/uffizzi-compose-events +38 -0
  67. data/man/uffizzi-compose-events.ronn +29 -0
  68. data/man/uffizzi-compose-list +58 -0
  69. data/man/uffizzi-compose-list.ronn +49 -0
  70. data/man/uffizzi-compose-service-list +42 -0
  71. data/man/uffizzi-compose-service-list.ronn +32 -0
  72. data/man/uffizzi-compose-service-logs +59 -0
  73. data/man/uffizzi-compose-service-logs.ronn +48 -0
  74. data/man/uffizzi-compose-update +61 -0
  75. data/man/uffizzi-compose-update.ronn +51 -0
  76. data/man/uffizzi-compose.ronn +33 -0
  77. data/man/uffizzi-compose_service_logs +59 -0
  78. data/man/uffizzi-compose_service_logs.ronn +50 -0
  79. data/man/uffizzi-config +2 -2
  80. data/man/uffizzi-config.ronn +1 -1
  81. data/man/uffizzi-connect +2 -4
  82. data/man/uffizzi-connect-acr +2 -2
  83. data/man/uffizzi-connect-acr.ronn +1 -1
  84. data/man/uffizzi-connect-docker-hub +2 -2
  85. data/man/uffizzi-connect-docker-hub.ronn +1 -1
  86. data/man/uffizzi-connect-docker-registry +2 -2
  87. data/man/uffizzi-connect-docker-registry.ronn +1 -1
  88. data/man/uffizzi-connect-ecr +2 -2
  89. data/man/uffizzi-connect-ecr.ronn +1 -1
  90. data/man/uffizzi-connect-gcr +2 -2
  91. data/man/uffizzi-connect-gcr.ronn +1 -1
  92. data/man/uffizzi-connect-ghcr +2 -2
  93. data/man/uffizzi-connect-ghcr.ronn +1 -1
  94. data/man/uffizzi-connect.ronn +2 -2
  95. data/man/uffizzi-disconnect +2 -2
  96. data/man/uffizzi-disconnect.ronn +1 -1
  97. data/man/uffizzi-login +7 -3
  98. data/man/uffizzi-login-by-identity-token +3 -3
  99. data/man/uffizzi-login-by-identity-token.ronn +2 -2
  100. data/man/uffizzi-login.html +113 -0
  101. data/man/uffizzi-login.ronn +6 -2
  102. data/man/uffizzi-logout +2 -2
  103. data/man/uffizzi-logout.ronn +1 -1
  104. data/man/uffizzi-preview +9 -9
  105. data/man/uffizzi-preview-create +22 -20
  106. data/man/uffizzi-preview-create.ronn +28 -26
  107. data/man/uffizzi-preview-delete +11 -10
  108. data/man/uffizzi-preview-delete.ronn +12 -11
  109. data/man/uffizzi-preview-describe +10 -10
  110. data/man/uffizzi-preview-describe.ronn +11 -11
  111. data/man/uffizzi-preview-events +12 -11
  112. data/man/uffizzi-preview-events.ronn +13 -12
  113. data/man/uffizzi-preview-list +19 -18
  114. data/man/uffizzi-preview-list.ronn +21 -20
  115. data/man/uffizzi-preview-service-list +16 -12
  116. data/man/uffizzi-preview-service-list.ronn +16 -13
  117. data/man/uffizzi-preview-service-logs +14 -12
  118. data/man/uffizzi-preview-service-logs.ronn +18 -17
  119. data/man/uffizzi-preview-update +19 -18
  120. data/man/uffizzi-preview-update.ronn +21 -20
  121. data/man/uffizzi-preview.ronn +10 -10
  122. data/man/uffizzi-preview_service_logs +14 -12
  123. data/man/uffizzi-preview_service_logs.ronn +18 -17
  124. data/man/uffizzi-project +3 -3
  125. data/man/uffizzi-project-compose +2 -2
  126. data/man/uffizzi-project-compose-describe +2 -2
  127. data/man/uffizzi-project-compose-describe.ronn +1 -1
  128. data/man/uffizzi-project-compose-set +2 -2
  129. data/man/uffizzi-project-compose-set.ronn +1 -1
  130. data/man/uffizzi-project-compose-unset +2 -2
  131. data/man/uffizzi-project-compose-unset.ronn +1 -1
  132. data/man/uffizzi-project-compose.ronn +1 -1
  133. data/man/uffizzi-project-create +2 -2
  134. data/man/uffizzi-project-create.ronn +1 -1
  135. data/man/uffizzi-project-delete +2 -2
  136. data/man/uffizzi-project-delete.ronn +1 -1
  137. data/man/uffizzi-project-describe +3 -3
  138. data/man/uffizzi-project-describe.ronn +1 -1
  139. data/man/uffizzi-project-preview-describe +37 -0
  140. data/man/uffizzi-project-preview-describe.ronn +29 -0
  141. data/man/uffizzi-project-preview-set +66 -0
  142. data/man/uffizzi-project-preview-set.ronn +57 -0
  143. data/man/uffizzi-project-secret +2 -2
  144. data/man/uffizzi-project-secret-create +2 -2
  145. data/man/uffizzi-project-secret-create.ronn +1 -1
  146. data/man/uffizzi-project-secret-delete +2 -2
  147. data/man/uffizzi-project-secret-delete.ronn +1 -1
  148. data/man/uffizzi-project-secret-list +2 -2
  149. data/man/uffizzi-project-secret-list.ronn +1 -1
  150. data/man/uffizzi-project-secret.ronn +1 -1
  151. data/man/uffizzi-project-set-default +2 -2
  152. data/man/uffizzi-project-set-default.ronn +1 -1
  153. data/man/uffizzi-project.html +124 -0
  154. data/man/uffizzi-project.ronn +2 -2
  155. data/man/uffizzi.ronn +12 -10
  156. metadata +134 -22
data/man/uffizzi-login CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-LOGIN" "" "May 2022" ""
3
+ .TH "UFFIZZI\-LOGIN" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-login\fR \- login to Uffizzi to view and manage your previews\.
6
6
  .SH "SYNOPSIS"
@@ -12,7 +12,7 @@ uffizzi login [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
12
12
  The uffizzi login command lets you authenticate with Uffizzi\.
13
13
 
14
14
  For more information on authentication and credential types, see:
15
- https://github\.com/UffizziCloud/uffizzi_cli
15
+ https://docs\.uffizzi\.com/references/cli/
16
16
  .fi
17
17
  .SH "UFFIZZI WIDE FLAGS"
18
18
  .nf
@@ -21,10 +21,14 @@ help for details\.
21
21
  .fi
22
22
  .SH "EXAMPLES"
23
23
  .nf
24
- To login to the default host with the default user account, run:
24
+ To login via the browser, run:
25
25
 
26
26
  $ uffizzi login
27
27
 
28
+ To login to the default host with the default user account, run:
29
+
30
+ $ uffizzi login \-\-email
31
+
28
32
  To login to an alternate host, run:
29
33
 
30
34
  $ uffizzi login \-\-server=uffizzi\.example\.com
data/man/uffizzi-login-by-identity-token CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-LOGIN\-BY\-IDENTITY\-TOKEN" "" "August 2022" ""
3
+ .TH "UFFIZZI\-LOGIN\-BY\-IDENTITY\-TOKEN" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-login\-by\-identity\-token\fR \- login to Uffizzi using a OIDC token provided by a CI/CD pipeline
6
6
  .SH "SYNOPSIS"
@@ -13,7 +13,7 @@ The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeli
13
13
  If a user/account do not exist, Uffizzi will create them based on token payload\.
14
14
 
15
15
  For more information on authentication and credential types, see:
16
- https://github\.com/UffizziCloud/uffizzi_cli
16
+ https://docs\.uffizzi\.com/references/cli/
17
17
  .fi
18
18
  .SH "UFFIZZI WIDE FLAGS"
19
19
  .nf
@@ -24,6 +24,6 @@ help for details\.
24
24
  .nf
25
25
  To login from the CI/CD pipeline, run:
26
26
 
27
- $ uffizzi uffizzi\-login\-by\-identity\-token \-\-server=uffizzi\.example\.com \-\-token=[$CI_JOB_TOKEN]
27
+ $ uffizzi uffizzi\-login\-by\-identity\-token \-\-server=uffizzi\.example\.com \-\-oidc\-token=[$CI_JOB_TOKEN]
28
28
  .fi
29
29
 
data/man/uffizzi-login-by-identity-token.ronn CHANGED
@@ -9,7 +9,7 @@
9
9
  If a user/account do not exist, Uffizzi will create them based on token payload.
10
10
 
11
11
  For more information on authentication and credential types, see:
12
- https://github.com/UffizziCloud/uffizzi_cli
12
+ https://docs.uffizzi.com/references/cli/
13
13
 
14
14
  ## UFFIZZI WIDE FLAGS
15
15
  These flags are available to all commands: --project. Run $ uffizzi
@@ -18,4 +18,4 @@
18
18
  ## EXAMPLES
19
19
  To login from the CI/CD pipeline, run:
20
20
 
21
- $ uffizzi uffizzi-login-by-identity-token --server=uffizzi.example.com --token=[$CI_JOB_TOKEN]
21
+ $ uffizzi uffizzi-login-by-identity-token --server=uffizzi.example.com --oidc-token=[$CI_JOB_TOKEN]
data/man/uffizzi-login.html ADDED
@@ -0,0 +1,113 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta http-equiv='content-type' content='text/html;charset=utf8'>
5
+ <meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'>
6
+ <title>login to Uffizzi to view and manage your previews.</title>
7
+ <style type='text/css' media='all'>
8
+ /* style: man */
9
+ body#manpage {margin:0}
10
+ .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
11
+ .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
12
+ .mp h2 {margin:10px 0 0 0}
13
+ .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
14
+ .mp h3 {margin:0 0 0 4ex}
15
+ .mp dt {margin:0;clear:left}
16
+ .mp dt.flush {float:left;width:8ex}
17
+ .mp dd {margin:0 0 0 9ex}
18
+ .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
19
+ .mp pre {margin-bottom:20px}
20
+ .mp pre+h2,.mp pre+h3 {margin-top:22px}
21
+ .mp h2+pre,.mp h3+pre {margin-top:5px}
22
+ .mp img {display:block;margin:auto}
23
+ .mp h1.man-title {display:none}
24
+ .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
25
+ .mp h2 {font-size:16px;line-height:1.25}
26
+ .mp h1 {font-size:20px;line-height:2}
27
+ .mp {text-align:justify;background:#fff}
28
+ .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
29
+ .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
30
+ .mp u {text-decoration:underline}
31
+ .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
32
+ .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
33
+ .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
34
+ .mp b.man-ref {font-weight:normal;color:#434241}
35
+ .mp pre {padding:0 4ex}
36
+ .mp pre code {font-weight:normal;color:#434241}
37
+ .mp h2+pre,h3+pre {padding-left:0}
38
+ ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
39
+ ol.man-decor {width:100%}
40
+ ol.man-decor li.tl {text-align:left}
41
+ ol.man-decor li.tc {text-align:center;letter-spacing:4px}
42
+ ol.man-decor li.tr {text-align:right;float:right}
43
+ </style>
44
+ </head>
45
+ <!--
46
+ The following styles are deprecated and will be removed at some point:
47
+ div#man, div#man ol.man, div#man ol.head, div#man ol.man.
48
+
49
+ The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
50
+ .man-navigation should be used instead.
51
+ -->
52
+ <body id='manpage'>
53
+ <div class='mp' id='man'>
54
+
55
+ <div class='man-navigation' style='display:none'>
56
+ <a href="#NAME">NAME</a>
57
+ <a href="#SYNOPSIS">SYNOPSIS</a>
58
+ <a href="#DESCRIPTION">DESCRIPTION</a>
59
+ <a href="#UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</a>
60
+ <a href="#EXAMPLES">EXAMPLES</a>
61
+ </div>
62
+
63
+ <ol class='man-decor man-head man head'>
64
+ <li class='tl'>uffizzi-login</li>
65
+ <li class='tc'></li>
66
+ <li class='tr'>uffizzi-login</li>
67
+ </ol>
68
+
69
+
70
+
71
+ <h2 id="NAME">NAME</h2>
72
+ <p class="man-name">
73
+ <code>uffizzi-login</code> - <span class="man-whatis">login to Uffizzi to view and manage your previews.</span>
74
+ </p>
75
+ <h2 id="SYNOPSIS">SYNOPSIS</h2>
76
+ <pre><code>uffizzi login [UFFIZZI_WIDE_FLAG ...]
77
+ </code></pre>
78
+
79
+ <h2 id="DESCRIPTION">DESCRIPTION</h2>
80
+ <pre><code>The uffizzi login command lets you authenticate with Uffizzi.
81
+
82
+ For more information on authentication and credential types, see:
83
+ https://github.com/UffizziCloud/uffizzi_cli
84
+ </code></pre>
85
+
86
+ <h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
87
+ <pre><code>These flags are available to all commands: --project. Run $ uffizzi
88
+ help for details.
89
+ </code></pre>
90
+
91
+ <h2 id="EXAMPLES">EXAMPLES</h2>
92
+ <pre><code>To login via the browser, run:
93
+
94
+ $ uffizzi login
95
+
96
+ To login to the default host with the default user account, run:
97
+
98
+ $ uffizzi login --email
99
+
100
+ To login to an alternate host, run:
101
+
102
+ $ uffizzi login --server=uffizzi.example.com
103
+ </code></pre>
104
+
105
+ <ol class='man-decor man-foot man foot'>
106
+ <li class='tl'></li>
107
+ <li class='tc'>July 2023</li>
108
+ <li class='tr'>uffizzi-login</li>
109
+ </ol>
110
+
111
+ </div>
112
+ </body>
113
+ </html>
data/man/uffizzi-login.ronn CHANGED
@@ -8,17 +8,21 @@
8
8
  The uffizzi login command lets you authenticate with Uffizzi.
9
9
 
10
10
  For more information on authentication and credential types, see:
11
- https://github.com/UffizziCloud/uffizzi_cli
11
+ https://docs.uffizzi.com/references/cli/
12
12
 
13
13
  ## UFFIZZI WIDE FLAGS
14
14
  These flags are available to all commands: --project. Run $ uffizzi
15
15
  help for details.
16
16
 
17
17
  ## EXAMPLES
18
- To login to the default host with the default user account, run:
18
+ To login via the browser, run:
19
19
 
20
20
  $ uffizzi login
21
21
 
22
+ To login to the default host with the default user account, run:
23
+
24
+ $ uffizzi login --email
25
+
22
26
  To login to an alternate host, run:
23
27
 
24
28
  $ uffizzi login --server=uffizzi.example.com
data/man/uffizzi-logout CHANGED
@@ -1,6 +1,6 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-LOGOUT" "" "May 2022" ""
3
+ .TH "UFFIZZI\-LOGOUT" "" "August 2023" ""
4
4
  .SH "NAME"
5
5
  \fBuffizzi\-logout\fR \- log out of a Uffizzi user account
6
6
  .SH "SYNOPSIS"
@@ -10,7 +10,7 @@
10
10
  The uffizzi logout command logs out of a Uffizzi user account\.
11
11
 
12
12
  For more information on logout, see:
13
- https://github\.com/UffizziCloud/uffizzi_cli
13
+ https://docs\.uffizzi\.com/references/cli/
14
14
  .fi
15
15
  .SH "UFFIZZI WIDE FLAGS"
16
16
  .nf
data/man/uffizzi-logout.ronn CHANGED
@@ -9,7 +9,7 @@ uffizzi-logout - log out of a Uffizzi user account
9
9
  The uffizzi logout command logs out of a Uffizzi user account.
10
10
 
11
11
  For more information on logout, see:
12
- https://github.com/UffizziCloud/uffizzi_cli
12
+ https://docs.uffizzi.com/references/cli/
13
13
 
14
14
  ## UFFIZZI WIDE FLAGS
15
15
  These flags are available to all commands: --project. Run $ uffizzi
data/man/uffizzi-preview CHANGED
@@ -1,18 +1,18 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PREVIEW" "" "May 2022" ""
3
+ .TH "UFFIZZI\-COMPOSE" "" "August 2023" ""
4
4
  .SH "NAME"
5
- \fBuffizzi\-preview\fR \- manage previews
5
+ \fBuffizzi\-compose\fR \- manage previews
6
6
  .SH "SYNOPSIS"
7
7
  .nf
8
- uffizzi preview COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
8
+ uffizzi compose COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
9
  .fi
10
10
  .SH "DESCRIPTION"
11
11
  .nf
12
12
  Manage Uffizzi previews
13
13
 
14
14
  For more information on Uffizzi previews, see:
15
- https://github\.com/UffizziCloud/uffizzi_cli
15
+ https://docs\.uffizzi\.com/references/cli/
16
16
  .fi
17
17
  .SH "UFFIZZI WIDE FLAGS"
18
18
  .nf
@@ -24,16 +24,16 @@ help for details\.
24
24
  COMMAND is one of the following:
25
25
 
26
26
  create
27
- Create a preview
27
+ Create a compose environment (preview)
28
28
 
29
29
  delete
30
- Delete a preview
30
+ Delete a compose environment (preview)
31
31
 
32
32
  describe
33
- Display details of a preview
33
+ Display details of a compose environment (preview)
34
34
 
35
35
  list
36
- List all previews
36
+ List all compose environments (previews)
37
37
  .fi
38
- .SH "Run \'uffizzi preview COMMAND \-\-help\' for more information on a command\."
38
+ .SH "Run \'uffizzi compose COMMAND \-\-help\' for more information on a command\."
39
39
 
data/man/uffizzi-preview-create CHANGED
@@ -1,16 +1,17 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PREVIEW\-CREATE" "" "August 2022" ""
3
+ .TH "UFFIZZI\-COMPOSE\-CREATE" "" "August 2023" ""
4
4
  .SH "NAME"
5
- \fBuffizzi\-preview\-create\fR \- create a preview
5
+ \fBuffizzi\-compose\-create\fR \- create a compose environment (preview)
6
6
  .SH "SYNOPSIS"
7
7
  .nf
8
- uffizzi preview create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
8
+ uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
9
  .fi
10
10
  .SH "DESCRIPTION"
11
11
  .nf
12
- Creates a new preview\. If no COMPOSE_FILE is specified, the preview
13
- is created with the project\'s default compose file\.
12
+ Creates a new compose environment (preview)\. If no COMPOSE_FILE is specified,
13
+ the compose environment (preview) is created with the project\'s default compose file\.
14
+ Run $ uffizzi project compose \-\-help for details\.
14
15
 
15
16
  This command can fail for the following reasons:
16
17
  \- The project does not have a default compose file set\. Run
@@ -18,7 +19,7 @@ This command can fail for the following reasons:
18
19
  \- The alternate compose file is invalid\.
19
20
 
20
21
  For more information on Uffizzi previews, see:
21
- https://github\.com/UffizziCloud/uffizzi_cli
22
+ https://docs\.uffizzi\.com/references/cli/
22
23
  .fi
23
24
  .SH "POSITIONAL ARGUMENTS"
24
25
  .nf
@@ -26,17 +27,18 @@ https://github\.com/UffizziCloud/uffizzi_cli
26
27
  An alternate compose file to the default compose\.
27
28
 
28
29
  You can pass a compose file to this command to create an ad hoc
29
- preview of an alternate compose configuration\. The file passed
30
- via this argument does not replace the default compose file for
31
- the project\. Alternate compose files share the same lifecyle as
32
- the previews they create: when the preview is deleted, the
33
- alternate compose is deleted by the Uffizzi API\.
30
+ compose environment (preview) of an alternate compose configuration\.
31
+ The file passed via this argument does not replace the default
32
+ compose file for the project\. Alternate compose files share the
33
+ same lifecyle as the previews they create: when the compose
34
+ environment (preview) is deleted, the alternate compose
35
+ is deleted by the Uffizzi API\.
34
36
  .fi
35
37
  .SH "FLAGS"
36
38
  .nf
37
39
  \-\-set\-labels=METADATA
38
40
  Metadata of deployment that contains any information which can
39
- be usefull for filtering deployments\.
41
+ be useful for filtering deployments\.
40
42
  .fi
41
43
  .SH "UFFIZZI WIDE FLAGS"
42
44
  .nf
@@ -45,21 +47,21 @@ help for details\.
45
47
  .fi
46
48
  .SH "EXAMPLES"
47
49
  .nf
48
- To create a preview with the project\'s default compose file, run:
50
+ To create a compose environment (preview) with the project\'s default compose file, run:
49
51
 
50
- $ uffizzi preview create
52
+ $ uffizzi compose create
51
53
 
52
- To create a preview with an alternate compose file, run:
54
+ To create a compose environment (preview) with an alternate compose file, run:
53
55
 
54
- $ uffizzi preview create docker\-compose\.uffizzi\.alt\.yml
56
+ $ uffizzi compose create docker\-compose\.uffizzi\.alt\.yml
55
57
 
56
- To create a preview with single label, run:
58
+ To create a compose environment (preview) with single label, run:
57
59
 
58
- $ uffizzi preview create \-\-set\-labels github\.repo=my_repo
60
+ $ uffizzi compose create \-\-set\-labels github\.repo=my_repo
59
61
 
60
- To create a preview with multiple labels, run:
62
+ To create a compose environment (preview) with multiple labels, run:
61
63
 
62
- $ uffizzi preview create \e
64
+ $ uffizzi compose create \e
63
65
  \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
64
66
  .fi
65
67
 
data/man/uffizzi-preview-create.ronn CHANGED
@@ -1,55 +1,57 @@
1
- uffizzi-preview-create - create a preview
1
+ uffizzi-compose-create - create a compose environment (preview)
2
2
  ================================================================
3
3
 
4
4
  ## SYNOPSIS
5
- uffizzi preview create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
5
+ uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
6
6
 
7
7
  ## DESCRIPTION
8
- Creates a new preview. If no COMPOSE_FILE is specified, the preview
9
- is created with the project's default compose file.
8
+ Creates a new compose environment (preview). If no COMPOSE_FILE is specified,
9
+ the compose environment (preview) is created with the project's default compose file.
10
+ Run $ uffizzi project compose --help for details.
10
11
 
11
- This command can fail for the following reasons:
12
- - The project does not have a default compose file set. Run
13
- $ uffizzi compose --help for details.
14
- - The alternate compose file is invalid.
12
+ This command can fail for the following reasons:
13
+ - The project does not have a default compose file set. Run
14
+ $ uffizzi compose --help for details.
15
+ - The alternate compose file is invalid.
15
16
 
16
17
  For more information on Uffizzi previews, see:
17
- https://github.com/UffizziCloud/uffizzi_cli
18
+ https://docs.uffizzi.com/references/cli/
18
19
 
19
20
  ## POSITIONAL ARGUMENTS
20
21
  [COMPOSE_FILE]
21
22
  An alternate compose file to the default compose.
22
23
 
23
- You can pass a compose file to this command to create an ad hoc
24
- preview of an alternate compose configuration. The file passed
25
- via this argument does not replace the default compose file for
26
- the project. Alternate compose files share the same lifecyle as
27
- the previews they create: when the preview is deleted, the
28
- alternate compose is deleted by the Uffizzi API.
24
+ You can pass a compose file to this command to create an ad hoc
25
+ compose environment (preview) of an alternate compose configuration.
26
+ The file passed via this argument does not replace the default
27
+ compose file for the project. Alternate compose files share the
28
+ same lifecyle as the previews they create: when the compose
29
+ environment (preview) is deleted, the alternate compose
30
+ is deleted by the Uffizzi API.
29
31
 
30
32
  ## FLAGS
31
33
  --set-labels=METADATA
32
34
  Metadata of deployment that contains any information which can
33
- be usefull for filtering deployments.
35
+ be useful for filtering deployments.
34
36
 
35
37
  ## UFFIZZI WIDE FLAGS
36
- These flags are available to all commands: --project. Run $ uffizzi
38
+ These flags are available to all commands: --project. Run $ uffizzi
37
39
  help for details.
38
40
 
39
41
  ## EXAMPLES
40
- To create a preview with the project's default compose file, run:
42
+ To create a compose environment (preview) with the project's default compose file, run:
41
43
 
42
- $ uffizzi preview create
44
+ $ uffizzi compose create
43
45
 
44
- To create a preview with an alternate compose file, run:
46
+ To create a compose environment (preview) with an alternate compose file, run:
45
47
 
46
- $ uffizzi preview create docker-compose.uffizzi.alt.yml
48
+ $ uffizzi compose create docker-compose.uffizzi.alt.yml
47
49
 
48
- To create a preview with single label, run:
50
+ To create a compose environment (preview) with single label, run:
49
51
 
50
- $ uffizzi preview create --set-labels github.repo=my_repo
52
+ $ uffizzi compose create --set-labels github.repo=my_repo
51
53
 
52
- To create a preview with multiple labels, run:
54
+ To create a compose environment (preview) with multiple labels, run:
53
55
 
54
- $ uffizzi preview create \
55
- --set-labels="github.repo=my_repo github.pull_request.number=23"
56
+ $ uffizzi compose create \
57
+ --set-labels="github.repo=my_repo github.pull_request.number=23"
data/man/uffizzi-preview-delete CHANGED
@@ -1,27 +1,28 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PREVIEW\-DELETE" "" "May 2022" ""
3
+ .TH "UFFIZZI\-COMPOSE\-DELETE" "" "August 2023" ""
4
4
  .SH "NAME"
5
- \fBuffizzi\-preview\-delete\fR \- delete a preview
5
+ \fBuffizzi\-compose\-delete\fR \- delete a compose environment (preview)
6
6
  .SH "SYNOPSIS"
7
7
  .nf
8
- uffizzi preview delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
8
+ uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
9
  .fi
10
10
  .SH "DESCRIPTION"
11
11
  .nf
12
- Deletes a preview with the given preview ID\.
12
+ Deletes a compose environment (preview) with
13
+ the given compose environment (preview) ID\.
13
14
 
14
15
  This command can fail for the following reasons:
15
- \- The preview specified does not exist\.
16
- \- The preview specified belongs to a different project\.
16
+ \- The compose environment (preview) specified does not exist\.
17
+ \- The compose environment (preview) specified belongs to a different project\.
17
18
 
18
19
  For more information on Uffizzi previews, see:
19
- https://github\.com/UffizziCloud/uffizzi_cli
20
+ https://docs\.uffizzi\.com/references/cli/
20
21
  .fi
21
22
  .SH "POSITIONAL ARGUMENTS"
22
23
  .nf
23
24
  [PREVIEW_ID]
24
- ID for the preview you want to delete\.
25
+ ID for the compose environment (preview) you want to delete\.
25
26
  .fi
26
27
  .SH "UFFIZZI WIDE FLAGS"
27
28
  .nf
@@ -30,8 +31,8 @@ help for details\.
30
31
  .fi
31
32
  .SH "EXAMPLES"
32
33
  .nf
33
- The following command deletes the preview with ID deployment\-213:
34
+ The following command deletes the compose environment (preview) with ID deployment\-213:
34
35
 
35
- $ uffizzi preview delete deployment\-213
36
+ $ uffizzi compose delete deployment\-213
36
37
  .fi
37
38
 
data/man/uffizzi-preview-delete.ronn CHANGED
@@ -1,28 +1,29 @@
1
- uffizzi-preview-delete - delete a preview
1
+ uffizzi-compose-delete - delete a compose environment (preview)
2
2
  ================================================================
3
3
 
4
4
  ## SYNOPSIS
5
- uffizzi preview delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
5
+ uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
6
6
 
7
7
  ## DESCRIPTION
8
- Deletes a preview with the given preview ID.
8
+ Deletes a compose environment (preview) with
9
+ the given compose environment (preview) ID.
9
10
 
10
11
  This command can fail for the following reasons:
11
- - The preview specified does not exist.
12
- - The preview specified belongs to a different project.
13
-
12
+ - The compose environment (preview) specified does not exist.
13
+ - The compose environment (preview) specified belongs to a different project.
14
+
14
15
  For more information on Uffizzi previews, see:
15
- https://github.com/UffizziCloud/uffizzi_cli
16
+ https://docs.uffizzi.com/references/cli/
16
17
 
17
18
  ## POSITIONAL ARGUMENTS
18
19
  [PREVIEW_ID]
19
- ID for the preview you want to delete.
20
+ ID for the compose environment (preview) you want to delete.
20
21
 
21
22
  ## UFFIZZI WIDE FLAGS
22
- These flags are available to all commands: --project. Run $ uffizzi
23
+ These flags are available to all commands: --project. Run $ uffizzi
23
24
  help for details.
24
25
 
25
26
  ## EXAMPLES
26
- The following command deletes the preview with ID deployment-213:
27
+ The following command deletes the compose environment (preview) with ID deployment-213:
27
28
 
28
- $ uffizzi preview delete deployment-213
29
+ $ uffizzi compose delete deployment-213
data/man/uffizzi-preview-describe CHANGED
@@ -1,27 +1,27 @@
1
1
  .\" generated with Ronn-NG/v0.9.1
2
2
  .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-PREVIEW\-DESCRIBE" "" "May 2022" ""
3
+ .TH "UFFIZZI\-COMPOSE\-DESCRIBE" "" "August 2023" ""
4
4
  .SH "NAME"
5
- \fBuffizzi\-preview\-describe\fR \- show metadata for a preview
5
+ \fBuffizzi\-compose\-describe\fR \- show metadata for a compose environment (preview)
6
6
  .SH "SYNOPSIS"
7
7
  .nf
8
- uffizzi preview describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
8
+ uffizzi compose describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
9
  .fi
10
10
  .SH "DESCRIPTION"
11
11
  .nf
12
- Shows metadata for a project given a valid preview ID\.
12
+ Shows metadata for a project given a valid compose environment (preview) ID\.
13
13
 
14
14
  This command can fail for the following reasons:
15
- \- The preview specified does not exist\.
16
- \- The preview specified belongs to a different project\.
15
+ \- The compose environment (preview) specified does not exist\.
16
+ \- The compose environment (preview) specified belongs to a different project\.
17
17
 
18
18
  For more information on Uffizzi previews, see:
19
- https://github\.com/UffizziCloud/uffizzi_cli
19
+ https://docs\.uffizzi\.com/references/cli/
20
20
  .fi
21
21
  .SH "POSITIONAL ARGUMENTS"
22
22
  .nf
23
23
  [PREVIEW_ID]
24
- ID for the preview you want to describe\.
24
+ ID for the compose environment (preview) you want to describe\.
25
25
  .fi
26
26
  .SH "UFFIZZI WIDE FLAGS"
27
27
  .nf
@@ -30,9 +30,9 @@ help for details\.
30
30
  .fi
31
31
  .SH "EXAMPLES"
32
32
  .nf
33
- The following command prints metadata for the preview with ID
33
+ The following command prints metadata for the compose environment (preview) with ID
34
34
  deployment\-213:
35
35
 
36
- $ uffizzi preview describe deployment\-213
36
+ $ uffizzi compose describe deployment\-213
37
37
  .fi
38
38
 
data/man/uffizzi-preview-describe.ronn CHANGED
@@ -1,29 +1,29 @@
1
- uffizzi-preview-describe - show metadata for a preview
1
+ uffizzi-compose-describe - show metadata for a compose environment (preview)
2
2
  ================================================================
3
3
 
4
4
  ## SYNOPSIS
5
- uffizzi preview describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
5
+ uffizzi compose describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
6
6
 
7
7
  ## DESCRIPTION
8
- Shows metadata for a project given a valid preview ID.
8
+ Shows metadata for a project given a valid compose environment (preview) ID.
9
9
 
10
10
  This command can fail for the following reasons:
11
- - The preview specified does not exist.
12
- - The preview specified belongs to a different project.
13
-
11
+ - The compose environment (preview) specified does not exist.
12
+ - The compose environment (preview) specified belongs to a different project.
13
+
14
14
  For more information on Uffizzi previews, see:
15
- https://github.com/UffizziCloud/uffizzi_cli
15
+ https://docs.uffizzi.com/references/cli/
16
16
 
17
17
  ## POSITIONAL ARGUMENTS
18
18
  [PREVIEW_ID]
19
- ID for the preview you want to describe.
19
+ ID for the compose environment (preview) you want to describe.
20
20
 
21
21
  ## UFFIZZI WIDE FLAGS
22
- These flags are available to all commands: --project. Run $ uffizzi
22
+ These flags are available to all commands: --project. Run $ uffizzi
23
23
  help for details.
24
24
 
25
25
  ## EXAMPLES
26
- The following command prints metadata for the preview with ID
26
+ The following command prints metadata for the compose environment (preview) with ID
27
27
  deployment-213:
28
28
 
29
- $ uffizzi preview describe deployment-213
29
+ $ uffizzi compose describe deployment-213