uffizzi-cli 2.0.34 → 2.0.36

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 (132) hide show
  1. checksums.yaml +4 -4
  2. data/lib/uffizzi/cli/cluster.rb +34 -5
  3. data/lib/uffizzi/cli/common.rb +1 -1
  4. data/lib/uffizzi/cli/project/compose.rb +2 -0
  5. data/lib/uffizzi/helpers/config_helper.rb +17 -0
  6. data/lib/uffizzi/services/cluster/disconnect_service.rb +71 -0
  7. data/lib/uffizzi/services/kubeconfig_service.rb +33 -8
  8. data/lib/uffizzi/version.rb +1 -1
  9. data/man/uffizzi +53 -0
  10. data/man/uffizzi-account +29 -0
  11. data/man/uffizzi-account-list +26 -0
  12. data/man/uffizzi-account-list.html +103 -0
  13. data/man/uffizzi-account-list.ronn +19 -0
  14. data/man/uffizzi-account-set-default +29 -0
  15. data/man/uffizzi-account-set-default.html +105 -0
  16. data/man/uffizzi-account-set-default.ronn +22 -0
  17. data/man/uffizzi-account.html +106 -0
  18. data/man/uffizzi-account.ronn +23 -0
  19. data/man/uffizzi-cluster +37 -0
  20. data/man/uffizzi-cluster-create +49 -0
  21. data/man/uffizzi-cluster-create.ronn +41 -0
  22. data/man/uffizzi-cluster-delete +32 -0
  23. data/man/uffizzi-cluster-delete.ronn +24 -0
  24. data/man/uffizzi-cluster-describe +39 -0
  25. data/man/uffizzi-cluster-describe.ronn +30 -0
  26. data/man/uffizzi-cluster-disconnect +40 -0
  27. data/man/uffizzi-cluster-disconnect.ronn +32 -0
  28. data/man/uffizzi-cluster-list +34 -0
  29. data/man/uffizzi-cluster-list.ronn +26 -0
  30. data/man/uffizzi-cluster-update-kubeconfig +37 -0
  31. data/man/uffizzi-cluster-update-kubeconfig.ronn +29 -0
  32. data/man/uffizzi-cluster.ronn +32 -0
  33. data/man/uffizzi-compose +39 -0
  34. data/man/uffizzi-compose-create +67 -0
  35. data/man/uffizzi-compose-create.ronn +57 -0
  36. data/man/uffizzi-compose-delete +38 -0
  37. data/man/uffizzi-compose-delete.ronn +29 -0
  38. data/man/uffizzi-compose-describe +38 -0
  39. data/man/uffizzi-compose-describe.ronn +29 -0
  40. data/man/uffizzi-compose-events +38 -0
  41. data/man/uffizzi-compose-events.ronn +29 -0
  42. data/man/uffizzi-compose-list +58 -0
  43. data/man/uffizzi-compose-list.ronn +49 -0
  44. data/man/uffizzi-compose-service-list +42 -0
  45. data/man/uffizzi-compose-service-list.ronn +32 -0
  46. data/man/uffizzi-compose-service-logs +59 -0
  47. data/man/uffizzi-compose-service-logs.ronn +48 -0
  48. data/man/uffizzi-compose-update +61 -0
  49. data/man/uffizzi-compose-update.ronn +51 -0
  50. data/man/uffizzi-compose.ronn +33 -0
  51. data/man/uffizzi-compose_service_logs +59 -0
  52. data/man/uffizzi-compose_service_logs.ronn +50 -0
  53. data/man/uffizzi-config +65 -0
  54. data/man/uffizzi-config.ronn +55 -0
  55. data/man/uffizzi-connect +40 -0
  56. data/man/uffizzi-connect-acr +37 -0
  57. data/man/uffizzi-connect-acr.ronn +42 -0
  58. data/man/uffizzi-connect-docker-hub +34 -0
  59. data/man/uffizzi-connect-docker-hub.ronn +39 -0
  60. data/man/uffizzi-connect-docker-registry +37 -0
  61. data/man/uffizzi-connect-docker-registry.ronn +41 -0
  62. data/man/uffizzi-connect-ecr +37 -0
  63. data/man/uffizzi-connect-ecr.ronn +42 -0
  64. data/man/uffizzi-connect-gcr +31 -0
  65. data/man/uffizzi-connect-gcr.ronn +36 -0
  66. data/man/uffizzi-connect-ghcr +34 -0
  67. data/man/uffizzi-connect-ghcr.ronn +40 -0
  68. data/man/uffizzi-connect.ronn +45 -0
  69. data/man/uffizzi-disconnect +37 -0
  70. data/man/uffizzi-disconnect.ronn +31 -0
  71. data/man/uffizzi-login +51 -0
  72. data/man/uffizzi-login-by-identity-token +29 -0
  73. data/man/uffizzi-login-by-identity-token.html +106 -0
  74. data/man/uffizzi-login-by-identity-token.ronn +21 -0
  75. data/man/uffizzi-login.html +113 -0
  76. data/man/uffizzi-login.ronn +41 -0
  77. data/man/uffizzi-logout +21 -0
  78. data/man/uffizzi-logout.ronn +19 -0
  79. data/man/uffizzi-preview +39 -0
  80. data/man/uffizzi-preview-create +67 -0
  81. data/man/uffizzi-preview-create.ronn +57 -0
  82. data/man/uffizzi-preview-delete +38 -0
  83. data/man/uffizzi-preview-delete.ronn +29 -0
  84. data/man/uffizzi-preview-describe +38 -0
  85. data/man/uffizzi-preview-describe.ronn +29 -0
  86. data/man/uffizzi-preview-events +38 -0
  87. data/man/uffizzi-preview-events.ronn +29 -0
  88. data/man/uffizzi-preview-list +58 -0
  89. data/man/uffizzi-preview-list.ronn +49 -0
  90. data/man/uffizzi-preview-service-list +42 -0
  91. data/man/uffizzi-preview-service-list.ronn +32 -0
  92. data/man/uffizzi-preview-service-logs +59 -0
  93. data/man/uffizzi-preview-service-logs.ronn +48 -0
  94. data/man/uffizzi-preview-update +61 -0
  95. data/man/uffizzi-preview-update.ronn +51 -0
  96. data/man/uffizzi-preview.ronn +33 -0
  97. data/man/uffizzi-preview_service_logs +59 -0
  98. data/man/uffizzi-preview_service_logs.ronn +50 -0
  99. data/man/uffizzi-project +47 -0
  100. data/man/uffizzi-project-compose +40 -0
  101. data/man/uffizzi-project-compose-describe +37 -0
  102. data/man/uffizzi-project-compose-describe.ronn +29 -0
  103. data/man/uffizzi-project-compose-set +66 -0
  104. data/man/uffizzi-project-compose-set.ronn +57 -0
  105. data/man/uffizzi-project-compose-unset +35 -0
  106. data/man/uffizzi-project-compose-unset.ronn +27 -0
  107. data/man/uffizzi-project-compose.ronn +34 -0
  108. data/man/uffizzi-project-create +50 -0
  109. data/man/uffizzi-project-create.ronn +41 -0
  110. data/man/uffizzi-project-delete +32 -0
  111. data/man/uffizzi-project-delete.ronn +24 -0
  112. data/man/uffizzi-project-describe +43 -0
  113. data/man/uffizzi-project-describe.ronn +34 -0
  114. data/man/uffizzi-project-preview-describe +37 -0
  115. data/man/uffizzi-project-preview-describe.ronn +29 -0
  116. data/man/uffizzi-project-preview-set +66 -0
  117. data/man/uffizzi-project-preview-set.ronn +57 -0
  118. data/man/uffizzi-project-secret +37 -0
  119. data/man/uffizzi-project-secret-create +29 -0
  120. data/man/uffizzi-project-secret-create.ronn +21 -0
  121. data/man/uffizzi-project-secret-delete +29 -0
  122. data/man/uffizzi-project-secret-delete.ronn +21 -0
  123. data/man/uffizzi-project-secret-list +28 -0
  124. data/man/uffizzi-project-secret-list.ronn +20 -0
  125. data/man/uffizzi-project-secret.ronn +30 -0
  126. data/man/uffizzi-project-set-default +34 -0
  127. data/man/uffizzi-project-set-default.ronn +26 -0
  128. data/man/uffizzi-project.html +124 -0
  129. data/man/uffizzi-project.ronn +41 -0
  130. data/man/uffizzi.html +132 -0
  131. data/man/uffizzi.ronn +45 -0
  132. metadata +126 -2
data/man/uffizzi-account-set-default.ronn ADDED
@@ -0,0 +1,22 @@
1
+ uffizzi-account-set-default - set the default account
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi account set-default ACCOUNT_NAME
6
+
7
+ ## DESCRIPTION
8
+ This command sets the default account (project) for the uffizzi configuration.
9
+ When set, all commands use this account as the default context unless
10
+ overridden by the --project flag.
11
+
12
+ This command can fail for the following reasons:
13
+ - There is no account with the given account name
14
+
15
+ For more information on Uffizzi projects, see:
16
+ https://docs.uffizzi.com/references/cli/
17
+
18
+ ## EXAMPLES
19
+ The following sets the default account with account name
20
+ example for the active account:
21
+
22
+ $ uffizzi account set-default example
data/man/uffizzi-account.html ADDED
@@ -0,0 +1,106 @@
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>manage Uffizzi accounts</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="#COMMANDS">COMMANDS</a>
60
+ </div>
61
+
62
+ <ol class='man-decor man-head man head'>
63
+ <li class='tl'>uffizzi-account</li>
64
+ <li class='tc'></li>
65
+ <li class='tr'>uffizzi-account</li>
66
+ </ol>
67
+
68
+
69
+
70
+ <h2 id="NAME">NAME</h2>
71
+ <p class="man-name">
72
+ <code>uffizzi-account</code> - <span class="man-whatis">manage Uffizzi accounts</span>
73
+ </p>
74
+ <h2 id="SYNOPSIS">SYNOPSIS</h2>
75
+ <pre><code>uffizzi account COMMAND [UFFIZZI_WIDE_FLAG ...]
76
+ </code></pre>
77
+
78
+ <h2 id="DESCRIPTION">DESCRIPTION</h2>
79
+ <pre><code>Manage Uffizzi accounts
80
+
81
+ For more information on Uffizzi accounts, see:
82
+ https://github.com/UffizziCloud/uffizzi_cli
83
+ </code></pre>
84
+
85
+ <h2 id="COMMANDS">COMMANDS</h2>
86
+ <pre><code>COMMAND is one of the following:
87
+
88
+ list
89
+ List all projects in the account.
90
+
91
+ set-default
92
+ Set the default project in the uffizzi configuration. Also see
93
+ $ uffizzi config help for details.
94
+ </code></pre>
95
+
96
+ <p>Run $ uffizzi account COMMAND --help for more information on a command.</p>
97
+
98
+ <ol class='man-decor man-foot man foot'>
99
+ <li class='tl'></li>
100
+ <li class='tc'>July 2023</li>
101
+ <li class='tr'>uffizzi-account</li>
102
+ </ol>
103
+
104
+ </div>
105
+ </body>
106
+ </html>
data/man/uffizzi-account.ronn ADDED
@@ -0,0 +1,23 @@
1
+ uffizzi-account - manage Uffizzi accounts
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi account COMMAND [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Manage Uffizzi accounts
9
+
10
+ For more information on Uffizzi accounts, see:
11
+ https://docs.uffizzi.com/references/cli/
12
+
13
+ ## COMMANDS
14
+ COMMAND is one of the following:
15
+
16
+ list
17
+ List all accounts associated with the user's credentials
18
+
19
+ set-default
20
+ Set the default account in the uffizzi configuration. Also see
21
+ $ uffizzi config help for details.
22
+
23
+ Run $ uffizzi account COMMAND --help for more information on a command.
data/man/uffizzi-cluster ADDED
@@ -0,0 +1,37 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-CLUSTER" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-cluster\fR \- manage clusters
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi cluster COMMAND
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Manage Uffizzi clusters
13
+
14
+ For more information on Uffizzi clusters, see:
15
+ https://docs\.uffizzi\.com/references/cli/
16
+ .fi
17
+ .SH "COMMANDS"
18
+ .nf
19
+ COMMAND is one of the following:
20
+
21
+ create
22
+ Create a cluster
23
+
24
+ delete
25
+ Delete a cluster
26
+
27
+ describe
28
+ Display details of a cluster
29
+
30
+ list
31
+ List all clusters
32
+
33
+ update\-kubeconfig
34
+ Update kubeconfig file
35
+ .fi
36
+ .SH "Run \'uffizzi cluster COMMAND \-\-help\' for more information on a command\."
37
+
data/man/uffizzi-cluster-create ADDED
@@ -0,0 +1,49 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-CLUSTER\-CREATE" "" "September 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-cluster\-create\fR \- create a cluster
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi cluster create
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Creates a new cluster\.
13
+
14
+ For more information on Uffizzi clusters, see:
15
+ https://docs\.uffizzi\.com/references/cli/
16
+ .fi
17
+ .SH "FLAGS"
18
+ .nf
19
+ \-\-name=CLUSTER\-NAME
20
+ Set cluster name
21
+
22
+ \-\-kubeconfig="/path/to/your/kubeconfig"
23
+ Path to kubeconfig file
24
+
25
+ \-\-manifest="/path/to/your/manifest"
26
+ Path to manifest file
27
+
28
+ \-\-update\-current\-context
29
+ Update current\-context in kubeconfig file
30
+
31
+ \-\-output=pretty\-json
32
+ \-\-output=json
33
+ Use this option for formatting output\.
34
+ .fi
35
+ .SH "EXAMPLES"
36
+ .nf
37
+ To create a cluster with the auto generated name, run:
38
+
39
+ $ uffizzi cluster create
40
+
41
+ To create a cluster with name, run:
42
+
43
+ $ uffizzi cluster create \-\-name="my\-cluster"
44
+
45
+ To create a cluster from a manifests directory, run:
46
+
47
+ $ uffizzi cluster create \-\-name="my\-cluster" \-\-manifest=manifests/
48
+ .fi
49
+
data/man/uffizzi-cluster-create.ronn ADDED
@@ -0,0 +1,41 @@
1
+ uffizzi-cluster-create - create a cluster
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi cluster create
6
+
7
+ ## DESCRIPTION
8
+ Creates a new cluster.
9
+
10
+ For more information on Uffizzi clusters, see:
11
+ https://docs.uffizzi.com/references/cli/
12
+
13
+ ## FLAGS
14
+ --name=CLUSTER-NAME
15
+ Set cluster name
16
+
17
+ --kubeconfig="/path/to/your/kubeconfig"
18
+ Path to kubeconfig file
19
+
20
+ --manifest="/path/to/your/manifest"
21
+ Path to manifest file
22
+
23
+ --update-current-context
24
+ Update current-context in kubeconfig file
25
+
26
+ --output=pretty-json
27
+ --output=json
28
+ Use this option for formatting output.
29
+
30
+ ## EXAMPLES
31
+ To create a cluster with the auto generated name, run:
32
+
33
+ $ uffizzi cluster create
34
+
35
+ To create a cluster with name, run:
36
+
37
+ $ uffizzi cluster create --name="my-cluster"
38
+
39
+ To create a cluster from a manifests directory, run:
40
+
41
+ $ uffizzi cluster create --name="my-cluster" --manifest=manifests/
data/man/uffizzi-cluster-delete ADDED
@@ -0,0 +1,32 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-CLUSTER\-DELETE" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-cluster\-delete\fR \- delete a cluster
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi cluster delete [CLUSTER_NAME]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Deletes a cluster with the given cluster name\.
13
+
14
+ This command can fail for the following reasons:
15
+ \- The cluster specified does not exist\.
16
+ \- The cluster specified belongs to a different project\.
17
+
18
+ For more information on Uffizzi clusters, see:
19
+ https://docs\.uffizzi\.com/references/cli/
20
+ .fi
21
+ .SH "POSITIONAL ARGUMENTS"
22
+ .nf
23
+ [CLUSTER_NAME]
24
+ Name for the cluster you want to delete\.
25
+ .fi
26
+ .SH "EXAMPLES"
27
+ .nf
28
+ The following command deletes the cluster with CLUSTER_NAME my\-cluster:
29
+
30
+ $ uffizzi cluster delete my\-cluster
31
+ .fi
32
+
data/man/uffizzi-cluster-delete.ronn ADDED
@@ -0,0 +1,24 @@
1
+ uffizzi-cluster-delete - delete a cluster
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi cluster delete [CLUSTER_NAME]
6
+
7
+ ## DESCRIPTION
8
+ Deletes a cluster with the given cluster name.
9
+
10
+ This command can fail for the following reasons:
11
+ - The cluster specified does not exist.
12
+ - The cluster specified belongs to a different project.
13
+
14
+ For more information on Uffizzi clusters, see:
15
+ https://docs.uffizzi.com/references/cli/
16
+
17
+ ## POSITIONAL ARGUMENTS
18
+ [CLUSTER_NAME]
19
+ Name for the cluster you want to delete.
20
+
21
+ ## EXAMPLES
22
+ The following command deletes the cluster with CLUSTER_NAME my-cluster:
23
+
24
+ $ uffizzi cluster delete my-cluster
data/man/uffizzi-cluster-describe ADDED
@@ -0,0 +1,39 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-CLUSTER\-DESCRIBE" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-cluster\-describe\fR \- show metadata for a cluster
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi cluster describe [CLUSTER_NAME] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Shows metadata for a cluster given a valid cluster NAME
13
+
14
+ This command can fail for the following reasons:
15
+ \- The cluster specified does not exist\.
16
+ \- The cluster specified belongs to a different project\.
17
+
18
+ For more information on Uffizzi clusters, see:
19
+ https://docs\.uffizzi\.com/references/cli/
20
+ .fi
21
+ .SH "POSITIONAL ARGUMENTS"
22
+ .nf
23
+ [CLUSTER_NAME]
24
+ NAME for the cluster you want to describe\.
25
+ .fi
26
+ .SH "FLAGS"
27
+ .nf
28
+ \-\-output=pretty\-json
29
+ \-\-output=json
30
+ Use this option for formatting output\.
31
+ .fi
32
+ .SH "EXAMPLES"
33
+ .nf
34
+ The following command prints metadata for the cluster with NAME
35
+ my\-cluster:
36
+
37
+ $ uffizzi cluster describe my\-cluster
38
+ .fi
39
+
data/man/uffizzi-cluster-describe.ronn ADDED
@@ -0,0 +1,30 @@
1
+ uffizzi-cluster-describe - show metadata for a cluster
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi cluster describe [CLUSTER_NAME] [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Shows metadata for a cluster given a valid cluster NAME
9
+
10
+ This command can fail for the following reasons:
11
+ - The cluster specified does not exist.
12
+ - The cluster specified belongs to a different project.
13
+
14
+ For more information on Uffizzi clusters, see:
15
+ https://docs.uffizzi.com/references/cli/
16
+
17
+ ## POSITIONAL ARGUMENTS
18
+ [CLUSTER_NAME]
19
+ NAME for the cluster you want to describe.
20
+
21
+ ## FLAGS
22
+ --output=pretty-json
23
+ --output=json
24
+ Use this option for formatting output.
25
+
26
+ ## EXAMPLES
27
+ The following command prints metadata for the cluster with NAME
28
+ my-cluster:
29
+
30
+ $ uffizzi cluster describe my-cluster
data/man/uffizzi-cluster-disconnect ADDED
@@ -0,0 +1,40 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-CLUSTER\-DISCONNECT" "" "September 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-cluster\-disconnect\fR \- disconnect from current cluster
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi cluster disconnect
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Switch current context to origin\.
13
+
14
+ For more information on Uffizzi clusters, see:
15
+ https://docs\.uffizzi\.com/references/cli/
16
+ .fi
17
+ .SH "FLAGS"
18
+ .nf
19
+ \-\-ask
20
+ Show list available contexts for kubeconfig
21
+
22
+ \-\-kubeconfig="/path/to/your/kubeconfig"
23
+ Path to kubeconfig file
24
+ .fi
25
+ .SH "EXAMPLES"
26
+ .nf
27
+ To disconnect from current cluster context to origin context, run:
28
+
29
+ $ uffizzi cluster disconnect
30
+
31
+ To disconnect from current cluster context to origin context
32
+ and set new origin current context, run:
33
+
34
+ $ uffizzi cluster disconnect \-\-ask
35
+
36
+ To disconnect from current cluster context to origin context for current kubeconfig, run:
37
+
38
+ $ uffizzi cluster disconnect \-\-kubeconfig="/path/to/your/kubeconfig"
39
+ .fi
40
+
data/man/uffizzi-cluster-disconnect.ronn ADDED
@@ -0,0 +1,32 @@
1
+ uffizzi-cluster-disconnect - disconnect from current cluster context
2
+ ====================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi cluster disconnect
6
+
7
+ ## DESCRIPTION
8
+ Switch current context to origin.
9
+
10
+ For more information on Uffizzi clusters, see:
11
+ https://docs.uffizzi.com/references/cli/
12
+
13
+ ## FLAGS
14
+ --ask
15
+ Show list available contexts for kubeconfig and set new origin current context
16
+
17
+ --kubeconfig="/path/to/your/kubeconfig"
18
+ Path to kubeconfig file
19
+
20
+ ## EXAMPLES
21
+ To disconnect from current cluster context to origin context, run:
22
+
23
+ $ uffizzi cluster disconnect
24
+
25
+ To disconnect from current cluster context to origin context
26
+ and set new origin current context, run:
27
+
28
+ $ uffizzi cluster disconnect --ask
29
+
30
+ To disconnect from current cluster context to origin context for current kubeconfig, run:
31
+
32
+ $ uffizzi cluster disconnect --kubeconfig="/path/to/your/kubeconfig"
data/man/uffizzi-cluster-list ADDED
@@ -0,0 +1,34 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-CLUSTER\-LIST" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-cluster\-list\fR \- list clusters in a project
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi cluster list [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Lists all clusters for a project, including active,
13
+ deploying and failed clusters\.
14
+
15
+ For more information on Uffizzi clusters, see:
16
+ https://docs\.uffizzi\.com/references/cli/
17
+ .fi
18
+ .SH "FLAGS"
19
+ .nf
20
+ \-\-output=pretty\-json
21
+ \-\-output=json
22
+ Use this option for formatting output\.
23
+ .fi
24
+ .SH "EXAMPLES"
25
+ .nf
26
+ To list all clusters, run:
27
+
28
+ $ uffizzi cluster list
29
+
30
+ To list all clusters in json format, run:
31
+
32
+ $ uffizzi cluster list \-\-output="pretty\-json"
33
+ .fi
34
+
data/man/uffizzi-cluster-list.ronn ADDED
@@ -0,0 +1,26 @@
1
+ uffizzi-cluster-list - list clusters in a project
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi cluster list [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Lists all clusters for a project, including active,
9
+ deploying and failed clusters.
10
+
11
+ For more information on Uffizzi clusters, see:
12
+ https://docs.uffizzi.com/references/cli/
13
+
14
+ ## FLAGS
15
+ --output=pretty-json
16
+ --output=json
17
+ Use this option for formatting output.
18
+
19
+ ## EXAMPLES
20
+ To list all clusters, run:
21
+
22
+ $ uffizzi cluster list
23
+
24
+ To list all clusters in json format, run:
25
+
26
+ $ uffizzi cluster list --output="pretty-json"
data/man/uffizzi-cluster-update-kubeconfig ADDED
@@ -0,0 +1,37 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-CLUSTER\-UPDATE\-KUBECONFIG" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-cluster\-update\-kubeconfig\fR \- update a kubeconfig
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi cluster update\-kubeconfig [CLUSTER_NAME]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Update your kubeconfig file\.
13
+
14
+ This command can fail for the following reasons:
15
+ \- Your kubeconfig file out of specification
16
+
17
+ For more information on Uffizzi clusters, see:
18
+ https://docs\.uffizzi\.com/references/cli/
19
+ .fi
20
+ .SH "FLAGS"
21
+ .nf
22
+ \-\-kubeconfig="/path/to/your/kubeconfig"
23
+ Path to kubeconfig file you want to update
24
+
25
+ \-\-print
26
+ Print kubeconfig to STDOUT without updating kubeconfig file\.
27
+
28
+ \-\-quiet
29
+ Quiet mode
30
+ .fi
31
+ .SH "EXAMPLES"
32
+ .nf
33
+ To update kubeconfig file, run:
34
+
35
+ $ uffizzi cluster update\-kubeconfig \-\-kubeconfig="/file/path/to/kubeconfig"
36
+ .fi
37
+
data/man/uffizzi-cluster-update-kubeconfig.ronn ADDED
@@ -0,0 +1,29 @@
1
+ uffizzi-cluster-update-kubeconfig - update a kubeconfig
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi cluster update-kubeconfig [CLUSTER_NAME]
6
+
7
+ ## DESCRIPTION
8
+ Update your kubeconfig file.
9
+
10
+ This command can fail for the following reasons:
11
+ - Your kubeconfig file out of specification
12
+
13
+ For more information on Uffizzi clusters, see:
14
+ https://docs.uffizzi.com/references/cli/
15
+
16
+ ## FLAGS
17
+ --kubeconfig="/path/to/your/kubeconfig"
18
+ Path to kubeconfig file you want to update
19
+
20
+ --print
21
+ Print kubeconfig to STDOUT without updating kubeconfig file.
22
+
23
+ --quiet
24
+ Quiet mode
25
+
26
+ ## EXAMPLES
27
+ To update kubeconfig file, run:
28
+
29
+ $ uffizzi cluster update-kubeconfig --kubeconfig="/file/path/to/kubeconfig"
data/man/uffizzi-cluster.ronn ADDED
@@ -0,0 +1,32 @@
1
+ uffizzi-cluster - manage clusters
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi cluster COMMAND
6
+
7
+ ## DESCRIPTION
8
+ Manage Uffizzi clusters
9
+
10
+ For more information on Uffizzi clusters, see:
11
+ https://docs.uffizzi.com/references/cli/
12
+
13
+ ## COMMANDS
14
+ COMMAND is one of the following:
15
+
16
+ create
17
+ Create a cluster
18
+
19
+ delete
20
+ Delete a cluster
21
+
22
+ describe
23
+ Display details of a cluster
24
+
25
+ list
26
+ List all clusters
27
+
28
+ update-kubeconfig
29
+ Update kubeconfig file
30
+
31
+ ##
32
+ Run 'uffizzi cluster COMMAND --help' for more information on a command.
data/man/uffizzi-compose ADDED
@@ -0,0 +1,39 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-COMPOSE" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-compose\fR \- manage previews
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi compose COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Manage Uffizzi previews
13
+
14
+ For more information on Uffizzi previews, see:
15
+ https://docs\.uffizzi\.com/references/cli/
16
+ .fi
17
+ .SH "UFFIZZI WIDE FLAGS"
18
+ .nf
19
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
20
+ help for details\.
21
+ .fi
22
+ .SH "COMMANDS"
23
+ .nf
24
+ COMMAND is one of the following:
25
+
26
+ create
27
+ Create a compose environment (preview)
28
+
29
+ delete
30
+ Delete a compose environment (preview)
31
+
32
+ describe
33
+ Display details of a compose environment (preview)
34
+
35
+ list
36
+ List all compose environments (previews)
37
+ .fi
38
+ .SH "Run \'uffizzi compose COMMAND \-\-help\' for more information on a command\."
39
+