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
@@ -0,0 +1,51 @@
1
+ uffizzi compose update - update a compose environment (preview)
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi compose update [COMPOSE_ENVIRONMENT_ID] [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Given a compose environment (preview) ID and new compose file,
9
+ update a compose environment (preview). Updating a compose
10
+ environment (preview) does not change its compose environment (preview) URL.
11
+
12
+ This command can fail for the following reasons:
13
+ - There is no compose environment (preview) with the given COMPOSE_ENVIRONMENT_ID
14
+ - The COMPOSE_FILE specified is invalid
15
+
16
+ For more information on Uffizzi previews, see:
17
+ https://docs.uffizzi.com/references/cli/
18
+
19
+ ## POSITIONAL ARGUMENTS
20
+ [COMPOSE_ENVIRONMENT_ID]
21
+ The ID of the compose environment (preview) that you want to update.
22
+
23
+ [COMPOSE_FILE]
24
+ The new compose file you want to compose environment (preview).
25
+
26
+ ## FLAGS
27
+ --set-labels=METADATA
28
+ Metadata of deployment that contains any information which can
29
+ be useful for filtering deployments.
30
+
31
+ ## UFFIZZI WIDE FLAGS
32
+ These flags are available to all commands: --project. Run $ uffizzi
33
+ help for details.
34
+
35
+ ## EXAMPLES
36
+ The following command updates a compose environment (preview)
37
+ with ID deployment-67 using compose file docker-compose.alt.yml:
38
+
39
+ $ uffizzi compose update deployment-67 docker-compose.alt.yml
40
+
41
+ To update a compose with single label, run:
42
+
43
+ $ uffizzi compose update \
44
+ deployment-67 docker-compose.alt.yml \
45
+ --set-labels github.repo=my_repo
46
+
47
+ To update a compose with multiple labels, run:
48
+
49
+ $ uffizzi compose update \
50
+ deployment-67 docker-compose.alt.yml \
51
+ --set-labels="github.repo=my_repo github.pull_request.number=23"
@@ -0,0 +1,33 @@
1
+ uffizzi-compose - manage previews
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi compose COMMAND [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ Manage Uffizzi previews
9
+
10
+ For more information on Uffizzi previews, see:
11
+ https://docs.uffizzi.com/references/cli/
12
+
13
+ ## UFFIZZI WIDE FLAGS
14
+ These flags are available to all commands: --project. Run $ uffizzi
15
+ help for details.
16
+
17
+ ## COMMANDS
18
+ COMMAND is one of the following:
19
+
20
+ create
21
+ Create a compose environment (preview)
22
+
23
+ delete
24
+ Delete a compose environment (preview)
25
+
26
+ describe
27
+ Display details of a compose environment (preview)
28
+
29
+ list
30
+ List all compose environments (previews)
31
+
32
+ ##
33
+ Run 'uffizzi compose COMMAND --help' for more information on a command.
@@ -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,50 @@
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
+
36
+ ## UFFIZZI WIDE FLAGS
37
+ These flags are available to all commands: --project. Run $ uffizzi
38
+ help for details.
39
+
40
+ ## EXAMPLES
41
+ The following command shows build logs for the service web-app of the
42
+ compose environment (preview) with ID deployment-14:
43
+
44
+ $ uffizzi compose service logs build deployment-14 web-app
45
+
46
+ The following command shows container logs for the service postgres-db of
47
+ the compose environment (preview) with ID deployment-14:
48
+
49
+ $ uffizzi compose service logs container deployment-14 postgres-db
50
+
@@ -0,0 +1,65 @@
1
+ .\" generated with Ronn-NG/v0.9.1
2
+ .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
+ .TH "CONFIG" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBconfig\fR \- configure the Uffizzi command\-line interface (CLI)
6
+ .SH "SYNOPSIS"
7
+ .nf
8
+ uffizzi config COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
9
+ .fi
10
+ .SH "DESCRIPTION"
11
+ .nf
12
+ The uffizzi config command lets you configure this command\-line application\.
13
+ If COMMAND is not specified, uffizzi config launches an interactive set up
14
+ guide\.
15
+
16
+ For more information on configuration options, see:
17
+ https://docs\.uffizzi\.com/references/cli/
18
+ .fi
19
+ .SH "UFFIZZI WIDE FLAGS"
20
+ .nf
21
+ These flags are available to all commands: \-\-project\. Run $ uffizzi
22
+ help for details\.
23
+ .fi
24
+ .SH "COMMANDS"
25
+ .nf
26
+ COMMAND is one of the following:
27
+
28
+ get\-value OPTION
29
+ Displays the value of the specified option\.
30
+
31
+ list
32
+ Lists all options and their values from the config file\.
33
+
34
+ set OPTION VALUE
35
+ Sets the value of the specified option\.
36
+
37
+ unset OPTION
38
+ Deletes the value of the specified option\.
39
+ .fi
40
+ .SH "OPTIONS"
41
+ .nf
42
+ OPTION is one of the following:
43
+
44
+ server
45
+ The server of the Uffizzi API service you want to access\. Defaults to
46
+ app\.uffizzi\.com\.
47
+
48
+ name
49
+ Your name\.
50
+
51
+ project
52
+ The current active project\. This project is used as the default unless
53
+ \-\-project is pass as an argument\.
54
+ .fi
55
+ .SH "EXAMPLES"
56
+ .nf
57
+ To list the uffizzi configuration options, run:
58
+
59
+ $ uffizzi config list
60
+
61
+ To set a new current active project for uffizzi, run:
62
+
63
+ $ uffizzi config set project my\-project
64
+ .fi
65
+
@@ -0,0 +1,55 @@
1
+ uffizzi config - configure the Uffizzi command-line interface (CLI)
2
+ ================================================================
3
+
4
+ ## SYNOPSIS
5
+ uffizzi config COMMAND [UFFIZZI_WIDE_FLAG ...]
6
+
7
+ ## DESCRIPTION
8
+ The uffizzi config command lets you configure this command-line application.
9
+ If COMMAND is not specified, uffizzi config launches an interactive set up
10
+ guide.
11
+
12
+ For more information on configuration options, see:
13
+ https://docs.uffizzi.com/references/cli/
14
+
15
+ ## UFFIZZI WIDE FLAGS
16
+ These flags are available to all commands: --project. Run $ uffizzi
17
+ help for details.
18
+
19
+ ## COMMANDS
20
+ COMMAND is one of the following:
21
+
22
+ get-value OPTION
23
+ Displays the value of the specified option.
24
+
25
+ list
26
+ Lists all options and their values from the config file.
27
+
28
+ set OPTION VALUE
29
+ Sets the value of the specified option.
30
+
31
+ unset OPTION
32
+ Deletes the value of the specified option.
33
+
34
+ ## OPTIONS
35
+ OPTION is one of the following:
36
+
37
+ server
38
+ The server of the Uffizzi API service you want to access. Defaults to
39
+ app.uffizzi.com.
40
+
41
+ name
42
+ Your name.
43
+
44
+ project
45
+ The current active project. This project is used as the default unless
46
+ --project is pass as an argument.
47
+
48
+ ## EXAMPLES
49
+ To list the uffizzi configuration options, run:
50
+
51
+ $ uffizzi config list
52
+
53
+ To set a new current active project for uffizzi, run:
54
+
55
+ $ uffizzi config set project my-project
@@ -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\-CONNECT" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-connect\fR \- grant a Uffizzi user account access to external services
6
+ .SH "SYNOPSIS"
7
+ \fBuffizzi connect\fR COMMAND [\-\-skip\-raise\-existence\-error] [\-\-update\-credential\-if\-exists]
8
+ .SH "DESCRIPTION"
9
+ Grants a Uffizzi user account access to external services\.
10
+ .P
11
+ For more information on connecting to external services, see: https://docs\.uffizzi\.com/references/cli/
12
+ .SH "COMMANDS"
13
+ COMMAND is one of the following:
14
+ .TP
15
+ \fBacr\fR
16
+ Connect to Azure Container Registry (azurecr\.io)\.
17
+ .TP
18
+ \fBdocker\-hub\fR
19
+ Connect to Docker Hub (hub\.docker\.com)\.
20
+ .TP
21
+ \fBdocker\-registry\fR
22
+ Connect to any registry implementing the Docker Registry HTTP API protocol
23
+ .TP
24
+ \fBecr\fR
25
+ Connect to Amazon Elastic Container Registry (amazonaws\.com)\.
26
+ .TP
27
+ \fBgcr\fR
28
+ Connect to Google Container Registry (gcr\.io)\.
29
+ .TP
30
+ \fBghcr\fR
31
+ Connect to GitHub Container Registry (ghcr\.io)\.
32
+ .SH "FLAGS"
33
+ .TP
34
+ \fB\-\-skip\-raise\-existence\-error\fR
35
+ If credential exists, do not raise an exception, just print a message\.
36
+ .TP
37
+ \fB\-\-update\-credential\-if\-exists\fR
38
+ Update credential if it exists\.
39
+ .P
40
+ Run \fBuffizzi connect COMMAND \-\-help\fR for more information on a command\.
@@ -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\-CONNECT\-ACR" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-connect\-acr\fR \- grant a Uffizzi user account access to a private Azure Container Registry (ACR)
6
+ .SH "SYNOPSIS"
7
+ \fBuffizzi connect acr\fR [\-\-registry=REGISTRY] [\-\-username=USERNAME] [\-\-password=PASSWORD]
8
+ .SH "DESCRIPTION"
9
+ Given valid credentials, grants a Uffizzi user account access to a private Azure Container Registry
10
+ .P
11
+ Credentials can be provided interactively or non\-interactively via command options or environment variables:
12
+ .br
13
+ \fBACR_REGISTRY_URL\fR, \fBACR_REGISTRY_USERNAME\fR, \fBACR_REGISTRY_PASSWORD\fR
14
+ .P
15
+ This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
16
+ .P
17
+ For more information on connecting to external services, see:
18
+ .br
19
+ https://docs\.uffizzi\.com/references/cli/
20
+ .P
21
+ For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
22
+ .br
23
+ https://docs\.uffizzi\.com/guides/container\-registry\-integrations
24
+ .SH "OPTIONS"
25
+ .TP
26
+ \fB\-r\fR, \fB\-\-registry=<registry>\fR
27
+ URL of the service\.
28
+ .TP
29
+ \fB\-u\fR, \fB\-\-username=<username>\fR
30
+ Username for the service\.
31
+ .TP
32
+ \fB\-p\fR, \fB\-\-password=<password>\fR
33
+ Password for the service\.
34
+ .SH "EXAMPLES"
35
+ The following command will prompt the user to enter ACR credentials, including registry domain, Docker ID and password or access token:
36
+ .P
37
+ \fBuffizzi connect acr\fR
@@ -0,0 +1,42 @@
1
+ # uffizzi-connect-acr - grant a Uffizzi user account access to a private Azure Container Registry (ACR)
2
+
3
+ ## SYNOPSIS
4
+
5
+ `uffizzi connect acr` [--registry=REGISTRY] [--username=USERNAME] [--password=PASSWORD]
6
+
7
+ ## DESCRIPTION
8
+
9
+ Given valid credentials, grants a Uffizzi user account access
10
+ to a private Azure Container Registry
11
+
12
+ Credentials can be provided interactively or non-interactively
13
+ via command options or environment variables:
14
+ `ACR_REGISTRY_URL`, `ACR_REGISTRY_USERNAME`, `ACR_REGISTRY_PASSWORD`
15
+
16
+ This command can fail for the following reasons:
17
+ - The active user does not have permission to connect external services.
18
+ - The given credentials are invalid.
19
+
20
+ For more information on connecting to external services, see:
21
+ https://docs.uffizzi.com/references/cli/
22
+
23
+ For detailed instructions on configuring webhooks to send push
24
+ notifications to Uffizzi, see:
25
+ https://docs.uffizzi.com/guides/container-registry-integrations
26
+
27
+ ## OPTIONS
28
+
29
+ * `-r`, `--registry=<registry>`:
30
+ URL of the service.
31
+ * `-u`, `--username=<username>`:
32
+ Username for the service.
33
+ * `-p`, `--password=<password>`:
34
+ Password for the service.
35
+
36
+ ## EXAMPLES
37
+
38
+ The following command will prompt the user to enter ACR
39
+ credentials, including registry domain, Docker ID and
40
+ password or access token:
41
+
42
+ `uffizzi connect acr`
@@ -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\-CONNECT\-DOCKER\-HUB" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-connect\-docker\-hub\fR \- grant a Uffizzi user account access to a private Docker Hub registry\.
6
+ .SH "SYNOPSIS"
7
+ \fBuffizzi connect docker\-hub\fR [\-\-username=USERNAME] [\-\-password=PASSWORD]
8
+ .SH "DESCRIPTION"
9
+ Given valid credentials, grants a Uffizzi user account access to a private Docker Hub registry
10
+ .P
11
+ Credentials can be provided interactively or non\-interactively via command options or environment variables:
12
+ .br
13
+ \fBDOCKERHUB_USERNAME\fR, \fBDOCKERHUB_PASSWORD\fR
14
+ .P
15
+ This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
16
+ .P
17
+ For more information on connecting to external services, see:
18
+ .br
19
+ https://docs\.uffizzi\.com/references/cli/
20
+ .P
21
+ For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
22
+ .br
23
+ https://docs\.uffizzi\.com/guides/container\-registry\-integrations
24
+ .SH "OPTIONS"
25
+ .TP
26
+ \fB\-u\fR, \fB\-\-username=<username>\fR
27
+ Username for the service\.
28
+ .TP
29
+ \fB\-p\fR, \fB\-\-password=<password>\fR
30
+ Password for the service\.
31
+ .SH "EXAMPLES"
32
+ The following command will prompt the user to enter Docker Hub credentials, including Docker ID and password or access token:
33
+ .P
34
+ \fBuffizzi connect docker\-hub\fR
@@ -0,0 +1,39 @@
1
+ # uffizzi-connect-docker-hub - grant a Uffizzi user account access to a private Docker Hub registry.
2
+
3
+ ## SYNOPSIS
4
+
5
+ `uffizzi connect docker-hub` [--username=USERNAME] [--password=PASSWORD]
6
+
7
+ ## DESCRIPTION
8
+
9
+ Given valid credentials, grants a Uffizzi user account access
10
+ to a private Docker Hub registry
11
+
12
+ Credentials can be provided interactively or non-interactively
13
+ via command options or environment variables:
14
+ `DOCKERHUB_USERNAME`, `DOCKERHUB_PASSWORD`
15
+
16
+ This command can fail for the following reasons:
17
+ - The active user does not have permission to connect external services.
18
+ - The given credentials are invalid.
19
+
20
+ For more information on connecting to external services, see:
21
+ https://docs.uffizzi.com/references/cli/
22
+
23
+ For detailed instructions on configuring webhooks to send push
24
+ notifications to Uffizzi, see:
25
+ https://docs.uffizzi.com/guides/container-registry-integrations
26
+
27
+ ## OPTIONS
28
+
29
+ * `-u`, `--username=<username>`:
30
+ Username for the service.
31
+ * `-p`, `--password=<password>`:
32
+ Password for the service.
33
+
34
+ ## EXAMPLES
35
+
36
+ The following command will prompt the user to enter Docker Hub
37
+ credentials, including Docker ID and password or access token:
38
+
39
+ `uffizzi connect docker-hub`
@@ -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\-CONNECT\-DOCKER\-REGISTRY" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-connect\-docker\-registry\fR \- grant a Uffizzi user account access to a Docker Container Registry\.
6
+ .SH "SYNOPSIS"
7
+ \fBuffizzi connect docker\-registry\fR [\-\-registry=REGISTRY] [\-\-username=USERNAME] [\-\-password=PASSWORD]
8
+ .SH "DESCRIPTION"
9
+ Given valid credentials, grants a Uffizzi user account access to a Docker Container Registry
10
+ .P
11
+ Credentials can be provided interactively or non\-interactively via command options or environment variables:
12
+ .br
13
+ \fBDOCKER_REGISTRY_URL\fR, \fBDOCKER_REGISTRY_USERNAME\fR, \fBDOCKER_REGISTRY_PASSWORD\fR
14
+ .P
15
+ This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
16
+ .P
17
+ For more information on connecting to external services, see:
18
+ .br
19
+ https://docs\.uffizzi\.com/references/cli/
20
+ .P
21
+ For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
22
+ .br
23
+ https://docs\.uffizzi\.com/guides/container\-registry\-integrations
24
+ .SH "OPTIONS"
25
+ .TP
26
+ \fB\-r\fR, \fB\-\-registry=<registry>\fR
27
+ URL of the service\.
28
+ .TP
29
+ \fB\-u\fR, \fB\-\-username=<username>\fR
30
+ Username for the service\.
31
+ .TP
32
+ \fB\-p\fR, \fB\-\-password=<password>\fR
33
+ Password for the service\.
34
+ .SH "EXAMPLES"
35
+ The following command will prompt the user to enter Docker Container Registry credentials, including username and password:
36
+ .P
37
+ \fBuffizzi connect docker\-registry\fR
@@ -0,0 +1,41 @@
1
+ # uffizzi-connect-docker-registry - grant a Uffizzi user account access to a Docker Container Registry.
2
+
3
+ ## SYNOPSIS
4
+
5
+ `uffizzi connect docker-registry` [--registry=REGISTRY] [--username=USERNAME] [--password=PASSWORD]
6
+
7
+ ## DESCRIPTION
8
+
9
+ Given valid credentials, grants a Uffizzi user account access
10
+ to a Docker Container Registry
11
+
12
+ Credentials can be provided interactively or non-interactively
13
+ via command options or environment variables:
14
+ `DOCKER_REGISTRY_URL`, `DOCKER_REGISTRY_USERNAME`, `DOCKER_REGISTRY_PASSWORD`
15
+
16
+ This command can fail for the following reasons:
17
+ - The active user does not have permission to connect external services.
18
+ - The given credentials are invalid.
19
+
20
+ For more information on connecting to external services, see:
21
+ https://docs.uffizzi.com/references/cli/
22
+
23
+ For detailed instructions on configuring webhooks to send push
24
+ notifications to Uffizzi, see:
25
+ https://docs.uffizzi.com/guides/container-registry-integrations
26
+
27
+ ## OPTIONS
28
+
29
+ * `-r`, `--registry=<registry>`:
30
+ URL of the service.
31
+ * `-u`, `--username=<username>`:
32
+ Username for the service.
33
+ * `-p`, `--password=<password>`:
34
+ Password for the service.
35
+
36
+ ## EXAMPLES
37
+
38
+ The following command will prompt the user to enter Docker Container Registry
39
+ credentials, including username and password:
40
+
41
+ `uffizzi connect docker-registry`
@@ -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\-CONNECT\-ECR" "" "August 2023" ""
4
+ .SH "NAME"
5
+ \fBuffizzi\-connect\-ecr\fR \- grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
6
+ .SH "SYNOPSIS"
7
+ \fBuffizzi connect ecr\fR [\-\-registry=REGISTRY] [\-\-id=ID] [\-\-secret=SECRET]
8
+ .SH "DESCRIPTION"
9
+ Given valid credentials, grants a Uffizzi user account access to a private Amazon Elastic Container Registry
10
+ .P
11
+ Credentials can be provided interactively or non\-interactively via command options or environment variables:
12
+ .br
13
+ \fBAWS_REGISTRY_URL\fR, \fBAWS_ACCESS_KEY_ID\fR, \fBAWS_SECRET_ACCESS_KEY\fR
14
+ .P
15
+ This command can fail for the following reasons: \- The active user does not have permission to connect external services\. \- The given credentials are invalid\.
16
+ .P
17
+ For more information on connecting to external services, see:
18
+ .br
19
+ https://docs\.uffizzi\.com/references/cli/
20
+ .P
21
+ For detailed instructions on configuring webhooks to send push notifications to Uffizzi, see:
22
+ .br
23
+ https://docs\.uffizzi\.com/guides/container\-registry\-integrations
24
+ .SH "OPTIONS"
25
+ .TP
26
+ \fB\-r\fR, \fB\-\-registry=<registry>\fR
27
+ URL of the service\.
28
+ .TP
29
+ \fB\-\-id=<id>\fR
30
+ Access key id for the service\.
31
+ .TP
32
+ \fB\-s\fR, \fB\-\-secret=<secret>\fR
33
+ Secret access key for the service\.
34
+ .SH "EXAMPLES"
35
+ The following command will prompt the user to enter ACR credentials, including registry domain, access key ID and secret access key:
36
+ .P
37
+ \fBuffizzi connect ecr\fR
@@ -0,0 +1,42 @@
1
+ # uffizzi-connect-ecr - grant a Uffizzi user account access to a private Amazon Elastic Container Registry (ECR)
2
+
3
+ ## SYNOPSIS
4
+
5
+ `uffizzi connect ecr` [--registry=REGISTRY] [--id=ID] [--secret=SECRET]
6
+
7
+ ## DESCRIPTION
8
+
9
+ Given valid credentials, grants a Uffizzi user account access
10
+ to a private Amazon Elastic Container Registry
11
+
12
+ Credentials can be provided interactively or non-interactively
13
+ via command options or environment variables:
14
+ `AWS_REGISTRY_URL`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`
15
+
16
+ This command can fail for the following reasons:
17
+ - The active user does not have permission to connect external services.
18
+ - The given credentials are invalid.
19
+
20
+ For more information on connecting to external services, see:
21
+ https://docs.uffizzi.com/references/cli/
22
+
23
+ For detailed instructions on configuring webhooks to send push
24
+ notifications to Uffizzi, see:
25
+ https://docs.uffizzi.com/guides/container-registry-integrations
26
+
27
+ ## OPTIONS
28
+
29
+ * `-r`, `--registry=<registry>`:
30
+ URL of the service.
31
+ * `--id=<id>`:
32
+ Access key id for the service.
33
+ * `-s`, `--secret=<secret>`:
34
+ Secret access key for the service.
35
+
36
+ ## EXAMPLES
37
+
38
+ The following command will prompt the user to enter ACR
39
+ credentials, including registry domain, access key ID and
40
+ secret access key:
41
+
42
+ `uffizzi connect ecr`