uffizzi-cli 2.0.34 → 2.0.36

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -0,0 +1,67 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-COMPOSE\-CREATE" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-compose\-create\fR \- create a compose environment (preview)
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
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\.
15
+
16
+ This command can fail for the following reasons:
17
+ \- The project does not have a default compose file set\. Run
18
+ $ uffizzi compose \-\-help for details\.
19
+ \- The alternate compose file is invalid\.
20
+
21
+ For more information on Uffizzi previews, see:
22
+ https://docs\.uffizzi\.com/references/cli/
23
+ .fi
24
+ .SH "POSITIONAL ARGUMENTS"
25
+ .nf
26
+ [COMPOSE_FILE]
27
+ An alternate compose file to the default compose\.
28
+
29
+ You can pass a compose file to this command to create an ad hoc
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\.
36
+ .fi
37
+ .SH "FLAGS"
38
+ .nf
39
+ \-\-set\-labels=METADATA
40
+ Metadata of deployment that contains any information which can
41
+ be useful for filtering deployments\.
42
+ .fi
43
+ .SH "UFFIZZI WIDE FLAGS"
44
+ .nf
45
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
46
+ help for details\.
47
+ .fi
48
+ .SH "EXAMPLES"
49
+ .nf
50
+ To create a compose environment (preview) with the project\'s default compose file, run:
51
+
52
+ $ uffizzi compose create
53
+
54
+ To create a compose environment (preview) with an alternate compose file, run:
55
+
56
+ $ uffizzi compose create docker\-compose\.uffizzi\.alt\.yml
57
+
58
+ To create a compose environment (preview) with single label, run:
59
+
60
+ $ uffizzi compose create \-\-set\-labels github\.repo=my_repo
61
+
62
+ To create a compose environment (preview) with multiple labels, run:
63
+
64
+ $ uffizzi compose create \e
65
+ \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
66
+ .fi
67
+
@@ -0,0 +1,57 @@
1
+ uffizzi-compose-create - create a compose environment (preview)
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi compose create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
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.
11
+
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.
16
+
17
+ For more information on Uffizzi previews, see:
18
+ https://docs.uffizzi.com/references/cli/
19
+
20
+ ## POSITIONAL ARGUMENTS
21
+ [COMPOSE_FILE]
22
+ An alternate compose file to the default compose.
23
+
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.
31
+
32
+ ## FLAGS
33
+ --set-labels=METADATA
34
+ Metadata of deployment that contains any information which can
35
+ be useful for filtering deployments.
36
+
37
+ ## UFFIZZI WIDE FLAGS
38
+ These flags are available to all commands: --project. Run $ uffizzi
39
+ help for details.
40
+
41
+ ## EXAMPLES
42
+ To create a compose environment (preview) with the project's default compose file, run:
43
+
44
+ $ uffizzi compose create
45
+
46
+ To create a compose environment (preview) with an alternate compose file, run:
47
+
48
+ $ uffizzi compose create docker-compose.uffizzi.alt.yml
49
+
50
+ To create a compose environment (preview) with single label, run:
51
+
52
+ $ uffizzi compose create --set-labels github.repo=my_repo
53
+
54
+ To create a compose environment (preview) with multiple labels, run:
55
+
56
+ $ uffizzi compose create \
57
+ --set-labels="github.repo=my_repo github.pull_request.number=23"
@@ -0,0 +1,38 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-COMPOSE\-DELETE" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-compose\-delete\fR \- delete a compose environment (preview)
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Deletes a compose environment (preview) with
13
+ the given compose environment (preview) ID\.
14
+
15
+ This command can fail for the following reasons:
16
+ \- The compose environment (preview) specified does not exist\.
17
+ \- The compose environment (preview) specified belongs to a different project\.
18
+
19
+ For more information on Uffizzi previews, see:
20
+ https://docs\.uffizzi\.com/references/cli/
21
+ .fi
22
+ .SH "POSITIONAL ARGUMENTS"
23
+ .nf
24
+ [PREVIEW_ID]
25
+ ID for the compose environment (preview) you want to delete\.
26
+ .fi
27
+ .SH "UFFIZZI WIDE FLAGS"
28
+ .nf
29
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
30
+ help for details\.
31
+ .fi
32
+ .SH "EXAMPLES"
33
+ .nf
34
+ The following command deletes the compose environment (preview) with ID deployment\-213:
35
+
36
+ $ uffizzi compose delete deployment\-213
37
+ .fi
38
+
@@ -0,0 +1,29 @@
1
+ uffizzi-compose-delete - delete a compose environment (preview)
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi compose delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Deletes a compose environment (preview) with
9
+ the given compose environment (preview) ID.
10
+
11
+ This command can fail for the following reasons:
12
+ - The compose environment (preview) specified does not exist.
13
+ - The compose environment (preview) specified belongs to a different project.
14
+
15
+ For more information on Uffizzi previews, see:
16
+ https://docs.uffizzi.com/references/cli/
17
+
18
+ ## POSITIONAL ARGUMENTS
19
+ [PREVIEW_ID]
20
+ ID for the compose environment (preview) you want to delete.
21
+
22
+ ## UFFIZZI WIDE FLAGS
23
+ These flags are available to all commands: --project. Run $ uffizzi
24
+ help for details.
25
+
26
+ ## EXAMPLES
27
+ The following command deletes the compose environment (preview) with ID deployment-213:
28
+
29
+ $ uffizzi compose delete deployment-213
@@ -0,0 +1,38 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-COMPOSE\-DESCRIBE" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-compose\-describe\fR \- show metadata for a compose environment (preview)
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi compose describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Shows metadata for a project given a valid compose environment (preview) ID\.
13
+
14
+ This command can fail for the following reasons:
15
+ \- The compose environment (preview) specified does not exist\.
16
+ \- The compose environment (preview) specified belongs to a different project\.
17
+
18
+ For more information on Uffizzi previews, see:
19
+ https://docs\.uffizzi\.com/references/cli/
20
+ .fi
21
+ .SH "POSITIONAL ARGUMENTS"
22
+ .nf
23
+ [PREVIEW_ID]
24
+ ID for the compose environment (preview) you want to describe\.
25
+ .fi
26
+ .SH "UFFIZZI WIDE FLAGS"
27
+ .nf
28
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
29
+ help for details\.
30
+ .fi
31
+ .SH "EXAMPLES"
32
+ .nf
33
+ The following command prints metadata for the compose environment (preview) with ID
34
+ deployment\-213:
35
+
36
+ $ uffizzi compose describe deployment\-213
37
+ .fi
38
+
@@ -0,0 +1,29 @@
1
+ uffizzi-compose-describe - show metadata for a compose environment (preview)
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi compose describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Shows metadata for a project given a valid compose environment (preview) ID.
9
+
10
+ This command can fail for the following reasons:
11
+ - The compose environment (preview) specified does not exist.
12
+ - The compose environment (preview) specified belongs to a different project.
13
+
14
+ For more information on Uffizzi previews, see:
15
+ https://docs.uffizzi.com/references/cli/
16
+
17
+ ## POSITIONAL ARGUMENTS
18
+ [PREVIEW_ID]
19
+ ID for the compose environment (preview) you want to describe.
20
+
21
+ ## UFFIZZI WIDE FLAGS
22
+ These flags are available to all commands: --project. Run $ uffizzi
23
+ help for details.
24
+
25
+ ## EXAMPLES
26
+ The following command prints metadata for the compose environment (preview) with ID
27
+ deployment-213:
28
+
29
+ $ uffizzi compose describe deployment-213
@@ -0,0 +1,38 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-COMPOSE\-EVENTS" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-compose\-events\fR \- show the deployment event logs for a compose environment (preview)
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi compose events [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Shows the deployment event logs for a given compose environment (preview)\.
13
+
14
+ This command can fail for the following reasons:
15
+ \- There is no compose environment (preview) with
16
+ the given compose environment (preview) ID
17
+
18
+ For more information on event logs, see:
19
+ https://docs\.uffizzi\.com/references/cli/
20
+ .fi
21
+ .SH "POSITIONAL ARGUMENTS"
22
+ .nf
23
+ [COMPOSE_ENVIRONMENT_ID]
24
+ The ID of the compose environment (preview) that you want to see events for\.
25
+ .fi
26
+ .SH "UFFIZZI WIDE FLAGS"
27
+ .nf
28
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
29
+ help for details\.
30
+ .fi
31
+ .SH "EXAMPLES"
32
+ .nf
33
+ The following command shows deployment events for
34
+ the compose environment (preview) with ID deployment\-67:
35
+
36
+ $ uffizzi compose events deployment\-67
37
+ .fi
38
+
@@ -0,0 +1,29 @@
1
+ uffizzi-compose-events - show the deployment event logs for a compose environment (preview)
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi compose events [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Shows the deployment event logs for a given compose environment (preview).
9
+
10
+ This command can fail for the following reasons:
11
+ - There is no compose environment (preview) with
12
+ the given compose environment (preview) ID
13
+
14
+ For more information on event logs, see:
15
+ https://docs.uffizzi.com/references/cli/
16
+
17
+ ## POSITIONAL ARGUMENTS
18
+ [COMPOSE_ENVIRONMENT_ID]
19
+ The ID of the compose environment (preview) that you want to see events for.
20
+
21
+ ## UFFIZZI WIDE FLAGS
22
+ These flags are available to all commands: --project. Run $ uffizzi
23
+ help for details.
24
+
25
+ ## EXAMPLES
26
+ The following command shows deployment events for
27
+ the compose environment (preview) with ID deployment-67:
28
+
29
+ $ uffizzi compose events deployment-67
@@ -0,0 +1,58 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-COMPOSE\-LIST" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-compose\-list\fR \- list compose environments (previews) in a project
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi compose list [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Lists all compose environments (previews) for a project,
13
+ including active, building, deploying and failed compose
14
+ environments (previews)\.
15
+
16
+ For more information on Uffizzi compose environments (previews), see:
17
+ https://docs\.uffizzi\.com/references/cli/
18
+ .fi
19
+ .SH "FLAGS"
20
+ .nf
21
+ \-\-filter=METADATA
22
+ Metadata to filter list of deployments\.
23
+
24
+ \-\-output=pretty\-json
25
+ Use this option for a more detailed description of listed
26
+ deployments\.
27
+ .fi
28
+ .SH "UFFIZZI WIDE FLAGS"
29
+ .nf
30
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
31
+ help for details\.
32
+ .fi
33
+ .SH "EXAMPLES"
34
+ .nf
35
+ To list all compose environments (previews) in the default project, run:
36
+
37
+ $ uffizzi compose list
38
+
39
+ To list all compose environments (previews) in a project with name my_project, run:
40
+
41
+ $ uffizzi compose list \-\-project="my_project"
42
+
43
+ To list all compose environments (previews) in json format, run:
44
+
45
+ $ uffizzi compose list \-\-output="pretty\-json"
46
+
47
+ To list all compose environments (previews) filtered by metadata using single
48
+ label, run:
49
+
50
+ $ uffizzi compose list \-\-filter github\.repo=my_repo
51
+
52
+ To list all compose environments (previews) filtered by metadata using multiple
53
+ labels, run:
54
+
55
+ $ uffizzi compose list \e
56
+ \-\-filter="github\.repo=my_repo github\.pull_request\.number=23"
57
+ .fi
58
+
@@ -0,0 +1,49 @@
1
+ uffizzi-compose-list - list compose environments (previews) in a project
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi compose list [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Lists all compose environments (previews) for a project,
9
+ including active, building, deploying and failed compose
10
+ environments (previews).
11
+
12
+ For more information on Uffizzi compose environments (previews), see:
13
+ https://docs.uffizzi.com/references/cli/
14
+
15
+ ## FLAGS
16
+ --filter=METADATA
17
+ Metadata to filter list of deployments.
18
+
19
+ --output=pretty-json
20
+ Use this option for a more detailed description of listed
21
+ deployments.
22
+
23
+ ## UFFIZZI WIDE FLAGS
24
+ These flags are available to all commands: --project. Run $ uffizzi
25
+ help for details.
26
+
27
+ ## EXAMPLES
28
+ To list all compose environments (previews) in the default project, run:
29
+
30
+ $ uffizzi compose list
31
+
32
+ To list all compose environments (previews) in a project with name my_project, run:
33
+
34
+ $ uffizzi compose list --project="my_project"
35
+
36
+ To list all compose environments (previews) in json format, run:
37
+
38
+ $ uffizzi compose list --output="pretty-json"
39
+
40
+ To list all compose environments (previews) filtered by metadata using single
41
+ label, run:
42
+
43
+ $ uffizzi compose list --filter github.repo=my_repo
44
+
45
+ To list all compose environments (previews) filtered by metadata using multiple
46
+ labels, run:
47
+
48
+ $ uffizzi compose list \
49
+ --filter="github.repo=my_repo github.pull_request.number=23"
@@ -0,0 +1,42 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-COMPOSE\-SERVICE\-LIST" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-compose\-service\-list\fR
6
+ .P
7
+ uffizzi\-compose\-service\-list \- list the container services of a given compose environment (preview) ================================================================
8
+ .SH "SYNOPSIS"
9
+ .nf
10
+ uffizzi compose service list [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
11
+ .fi
12
+ .SH "DESCRIPTION"
13
+ .nf
14
+ Shows a list of the container services that make up a given
15
+ compose environment (preview) deployment\.
16
+
17
+ This command can fail for the following reasons:
18
+ \- There is no compose environment (preview)
19
+ with the given COMPOSE_ENVIRONMENT_ID
20
+
21
+ For more information on preview services, see:
22
+ https://docs\.uffizzi\.com/references/cli/
23
+ .fi
24
+ .SH "POSITIONAL ARGUMENTS"
25
+ .nf
26
+ [COMPOSE_ENVIRONMENT_ID]
27
+ The ID of the compose environment (preview) you want to list services for\.
28
+ .fi
29
+ .SH "UFFIZZI WIDE FLAGS"
30
+ .nf
31
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
32
+ help for details\.
33
+ .fi
34
+ .SH "EXAMPLES"
35
+ .nf
36
+ The following command lists the container services
37
+ for a compose environment (preview) with
38
+ COMPOSE_ENVIRONMENT_ID deployment\-56:
39
+
40
+ $ uffizzi compose service list deployment\-56
41
+ .fi
42
+
@@ -0,0 +1,32 @@
1
+ uffizzi-compose-service-list - list the container services
2
+ of a given compose environment (preview)
3
+ ================================================================
4
+
5
+ ## SYNOPSIS
6
+ uffizzi compose service list [COMPOSE_ENVIRONMENT_ID] [UFFIZZI_WIDE_FLAG ...]
7
+
8
+ ## DESCRIPTION
9
+ Shows a list of the container services that make up a given
10
+ compose environment (preview) deployment.
11
+
12
+ This command can fail for the following reasons:
13
+ - There is no compose environment (preview)
14
+ with the given COMPOSE_ENVIRONMENT_ID
15
+
16
+ For more information on preview services, see:
17
+ https://docs.uffizzi.com/references/cli/
18
+
19
+ ## POSITIONAL ARGUMENTS
20
+ [COMPOSE_ENVIRONMENT_ID]
21
+ The ID of the compose environment (preview) you want to list services for.
22
+
23
+ ## UFFIZZI WIDE FLAGS
24
+ These flags are available to all commands: --project. Run $ uffizzi
25
+ help for details.
26
+
27
+ ## EXAMPLES
28
+ The following command lists the container services
29
+ for a compose environment (preview) with
30
+ COMPOSE_ENVIRONMENT_ID deployment-56:
31
+
32
+ $ uffizzi compose service list deployment-56
@@ -0,0 +1,59 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UFFIZZI\-COMPOSE\-SERVICE\-LOGS" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-compose\-service\-logs\fR
6
+ .P
7
+ uffizzi\-compose\-service\-logs \- show the logs for a container service of a compose environment (preview) ================================================================
8
+ .SH "SYNOPSIS"
9
+ .nf
10
+ uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
11
+ .fi
12
+ .SH "DESCRIPTION"
13
+ .nf
14
+ Shows the logs for a given container service of a given compose environment (preview)\.
15
+
16
+ This command can fail for the following reasons:
17
+ \- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
18
+ \- There is no service with the name SERVICE
19
+
20
+ For more information on service logs, see:
21
+ https://docs\.uffizzi\.com/references/cli/
22
+ .fi
23
+ .SH "LOG_TYPE"
24
+ .nf
25
+ LOG_TYPE is one of the following:
26
+
27
+ build
28
+ The build logs of a service\.
29
+
30
+ container
31
+ The container logs of a service\.
32
+ .fi
33
+ .SH "POSITIONAL ARGUMENTS"
34
+ .nf
35
+ [COMPOSE_ENVIRONMENT_ID]
36
+ The ID of the compose environment (preview) that includes the service you want to
37
+ show logs for\.
38
+
39
+ [SERVICE]
40
+ The name of the service you want to show logs for\.
41
+ .fi
42
+ .SH "UFFIZZI WIDE FLAGS"
43
+ .nf
44
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
45
+ help for details\.
46
+ .fi
47
+ .SH "EXAMPLES"
48
+ .nf
49
+ The following command shows build logs for the service web\-app of the
50
+ compose environment (preview) with ID deployment\-14:
51
+
52
+ $ uffizzi compose service logs build deployment\-14 web\-app
53
+
54
+ The following command shows container logs for the service postgres\-db of
55
+ the compose environment (preview) with ID deployment\-14:
56
+
57
+ $ uffizzi compose service logs container deployment\-14 postgres\-db
58
+ .fi
59
+
@@ -0,0 +1,48 @@
1
+ uffizzi-compose-service-logs - show the logs for a container service
2
+ of a compose environment (preview)
3
+ ================================================================
4
+
5
+ ## SYNOPSIS
6
+ uffizzi compose service logs LOG_TYPE [COMPOSE_ENVIRONMENT_ID] [SERVICE] [UFFIZZI_WIDE_FLAG ...]
7
+
8
+ ## DESCRIPTION
9
+ Shows the logs for a given container service of a given compose environment (preview).
10
+
11
+ This command can fail for the following reasons:
12
+ - There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
13
+ - There is no service with the name SERVICE
14
+
15
+ For more information on service logs, see:
16
+ https://docs.uffizzi.com/references/cli/
17
+
18
+ ## LOG_TYPE
19
+ LOG_TYPE is one of the following:
20
+
21
+ build
22
+ The build logs of a service.
23
+
24
+ container
25
+ The container logs of a service.
26
+
27
+ ## POSITIONAL ARGUMENTS
28
+ [COMPOSE_ENVIRONMENT_ID]
29
+ The ID of the compose environment (preview) that includes the service you want to
30
+ show logs for.
31
+
32
+ [SERVICE]
33
+ The name of the service you want to show logs for.
34
+
35
+ ## UFFIZZI WIDE FLAGS
36
+ These flags are available to all commands: --project. Run $ uffizzi
37
+ help for details.
38
+
39
+ ## EXAMPLES
40
+ The following command shows build logs for the service web-app of the
41
+ compose environment (preview) with ID deployment-14:
42
+
43
+ $ uffizzi compose service logs build deployment-14 web-app
44
+
45
+ The following command shows container logs for the service postgres-db of
46
+ the compose environment (preview) with ID deployment-14:
47
+
48
+ $ uffizzi compose service logs container deployment-14 postgres-db
@@ -0,0 +1,61 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "UPDATE" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBupdate\fR \- update a compose environment (preview)
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi compose update [COMPOSE_ENVIRONMENT_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ Given a compose environment (preview) ID and new compose file,
13
+ update a compose environment (preview)\. Updating a compose
14
+ environment (preview) does not change its compose environment (preview) URL\.
15
+
16
+ This command can fail for the following reasons:
17
+ \- There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
18
+ \- The COMPOSE_FILE specified is invalid
19
+
20
+ For more information on Uffizzi previews, see:
21
+ https://docs\.uffizzi\.com/references/cli/
22
+ .fi
23
+ .SH "POSITIONAL ARGUMENTS"
24
+ .nf
25
+ [COMPOSE_ENVIRONMENT_ID]
26
+ The ID of the compose environment (preview) that you want to update\.
27
+
28
+ [COMPOSE_FILE]
29
+ The new compose file you want to compose environment (preview)\.
30
+ .fi
31
+ .SH "FLAGS"
32
+ .nf
33
+ \-\-set\-labels=METADATA
34
+ Metadata of deployment that contains any information which can
35
+ be useful for filtering deployments\.
36
+ .fi
37
+ .SH "UFFIZZI WIDE FLAGS"
38
+ .nf
39
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
40
+ help for details\.
41
+ .fi
42
+ .SH "EXAMPLES"
43
+ .nf
44
+ The following command updates a compose environment (preview)
45
+ with ID deployment\-67 using compose file docker\-compose\.alt\.yml:
46
+
47
+ $ uffizzi compose update deployment\-67 docker\-compose\.alt\.yml
48
+
49
+ To update a compose with single label, run:
50
+
51
+ $ uffizzi compose update \e
52
+ deployment\-67 docker\-compose\.alt\.yml \e
53
+ \-\-set\-labels github\.repo=my_repo
54
+
55
+ To update a compose with multiple labels, run:
56
+
57
+ $ uffizzi compose update \e
58
+ deployment\-67 docker\-compose\.alt\.yml \e
59
+ \-\-set\-labels="github\.repo=my_repo github\.pull_request\.number=23"
60
+ .fi
61
+