uffizzi-cli 2.0.32 → 2.0.34

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 (125) hide show
  1. checksums.yaml +4 -4
  2. data/lib/uffizzi/cli/common.rb +1 -1
  3. data/lib/uffizzi/version.rb +1 -1
  4. metadata +2 -123
  5. data/man/uffizzi +0 -53
  6. data/man/uffizzi-account +0 -29
  7. data/man/uffizzi-account-list +0 -26
  8. data/man/uffizzi-account-list.html +0 -103
  9. data/man/uffizzi-account-list.ronn +0 -19
  10. data/man/uffizzi-account-set-default +0 -29
  11. data/man/uffizzi-account-set-default.html +0 -105
  12. data/man/uffizzi-account-set-default.ronn +0 -22
  13. data/man/uffizzi-account.html +0 -106
  14. data/man/uffizzi-account.ronn +0 -23
  15. data/man/uffizzi-cluster +0 -37
  16. data/man/uffizzi-cluster-create +0 -49
  17. data/man/uffizzi-cluster-create.ronn +0 -41
  18. data/man/uffizzi-cluster-delete +0 -32
  19. data/man/uffizzi-cluster-delete.ronn +0 -24
  20. data/man/uffizzi-cluster-describe +0 -39
  21. data/man/uffizzi-cluster-describe.ronn +0 -30
  22. data/man/uffizzi-cluster-list +0 -34
  23. data/man/uffizzi-cluster-list.ronn +0 -26
  24. data/man/uffizzi-cluster-update-kubeconfig +0 -37
  25. data/man/uffizzi-cluster-update-kubeconfig.ronn +0 -29
  26. data/man/uffizzi-cluster.ronn +0 -32
  27. data/man/uffizzi-compose +0 -39
  28. data/man/uffizzi-compose-create +0 -67
  29. data/man/uffizzi-compose-create.ronn +0 -57
  30. data/man/uffizzi-compose-delete +0 -38
  31. data/man/uffizzi-compose-delete.ronn +0 -29
  32. data/man/uffizzi-compose-describe +0 -38
  33. data/man/uffizzi-compose-describe.ronn +0 -29
  34. data/man/uffizzi-compose-events +0 -38
  35. data/man/uffizzi-compose-events.ronn +0 -29
  36. data/man/uffizzi-compose-list +0 -58
  37. data/man/uffizzi-compose-list.ronn +0 -49
  38. data/man/uffizzi-compose-service-list +0 -42
  39. data/man/uffizzi-compose-service-list.ronn +0 -32
  40. data/man/uffizzi-compose-service-logs +0 -59
  41. data/man/uffizzi-compose-service-logs.ronn +0 -48
  42. data/man/uffizzi-compose-update +0 -61
  43. data/man/uffizzi-compose-update.ronn +0 -51
  44. data/man/uffizzi-compose.ronn +0 -33
  45. data/man/uffizzi-compose_service_logs +0 -59
  46. data/man/uffizzi-compose_service_logs.ronn +0 -50
  47. data/man/uffizzi-config +0 -65
  48. data/man/uffizzi-config.ronn +0 -55
  49. data/man/uffizzi-connect +0 -40
  50. data/man/uffizzi-connect-acr +0 -37
  51. data/man/uffizzi-connect-acr.ronn +0 -42
  52. data/man/uffizzi-connect-docker-hub +0 -34
  53. data/man/uffizzi-connect-docker-hub.ronn +0 -39
  54. data/man/uffizzi-connect-docker-registry +0 -37
  55. data/man/uffizzi-connect-docker-registry.ronn +0 -41
  56. data/man/uffizzi-connect-ecr +0 -37
  57. data/man/uffizzi-connect-ecr.ronn +0 -42
  58. data/man/uffizzi-connect-gcr +0 -31
  59. data/man/uffizzi-connect-gcr.ronn +0 -36
  60. data/man/uffizzi-connect-ghcr +0 -34
  61. data/man/uffizzi-connect-ghcr.ronn +0 -40
  62. data/man/uffizzi-connect.ronn +0 -45
  63. data/man/uffizzi-disconnect +0 -37
  64. data/man/uffizzi-disconnect.ronn +0 -31
  65. data/man/uffizzi-login +0 -36
  66. data/man/uffizzi-login-by-identity-token +0 -29
  67. data/man/uffizzi-login-by-identity-token.html +0 -106
  68. data/man/uffizzi-login-by-identity-token.ronn +0 -21
  69. data/man/uffizzi-login.html +0 -113
  70. data/man/uffizzi-login.ronn +0 -28
  71. data/man/uffizzi-logout +0 -21
  72. data/man/uffizzi-logout.ronn +0 -19
  73. data/man/uffizzi-preview +0 -39
  74. data/man/uffizzi-preview-create +0 -67
  75. data/man/uffizzi-preview-create.ronn +0 -57
  76. data/man/uffizzi-preview-delete +0 -38
  77. data/man/uffizzi-preview-delete.ronn +0 -29
  78. data/man/uffizzi-preview-describe +0 -38
  79. data/man/uffizzi-preview-describe.ronn +0 -29
  80. data/man/uffizzi-preview-events +0 -38
  81. data/man/uffizzi-preview-events.ronn +0 -29
  82. data/man/uffizzi-preview-list +0 -58
  83. data/man/uffizzi-preview-list.ronn +0 -49
  84. data/man/uffizzi-preview-service-list +0 -42
  85. data/man/uffizzi-preview-service-list.ronn +0 -32
  86. data/man/uffizzi-preview-service-logs +0 -59
  87. data/man/uffizzi-preview-service-logs.ronn +0 -48
  88. data/man/uffizzi-preview-update +0 -61
  89. data/man/uffizzi-preview-update.ronn +0 -51
  90. data/man/uffizzi-preview.ronn +0 -33
  91. data/man/uffizzi-preview_service_logs +0 -59
  92. data/man/uffizzi-preview_service_logs.ronn +0 -50
  93. data/man/uffizzi-project +0 -47
  94. data/man/uffizzi-project-compose +0 -40
  95. data/man/uffizzi-project-compose-describe +0 -37
  96. data/man/uffizzi-project-compose-describe.ronn +0 -29
  97. data/man/uffizzi-project-compose-set +0 -66
  98. data/man/uffizzi-project-compose-set.ronn +0 -57
  99. data/man/uffizzi-project-compose-unset +0 -35
  100. data/man/uffizzi-project-compose-unset.ronn +0 -27
  101. data/man/uffizzi-project-compose.ronn +0 -34
  102. data/man/uffizzi-project-create +0 -50
  103. data/man/uffizzi-project-create.ronn +0 -41
  104. data/man/uffizzi-project-delete +0 -32
  105. data/man/uffizzi-project-delete.ronn +0 -24
  106. data/man/uffizzi-project-describe +0 -43
  107. data/man/uffizzi-project-describe.ronn +0 -34
  108. data/man/uffizzi-project-preview-describe +0 -37
  109. data/man/uffizzi-project-preview-describe.ronn +0 -29
  110. data/man/uffizzi-project-preview-set +0 -66
  111. data/man/uffizzi-project-preview-set.ronn +0 -57
  112. data/man/uffizzi-project-secret +0 -37
  113. data/man/uffizzi-project-secret-create +0 -29
  114. data/man/uffizzi-project-secret-create.ronn +0 -21
  115. data/man/uffizzi-project-secret-delete +0 -29
  116. data/man/uffizzi-project-secret-delete.ronn +0 -21
  117. data/man/uffizzi-project-secret-list +0 -28
  118. data/man/uffizzi-project-secret-list.ronn +0 -20
  119. data/man/uffizzi-project-secret.ronn +0 -30
  120. data/man/uffizzi-project-set-default +0 -34
  121. data/man/uffizzi-project-set-default.ronn +0 -26
  122. data/man/uffizzi-project.html +0 -124
  123. data/man/uffizzi-project.ronn +0 -41
  124. data/man/uffizzi.html +0 -132
  125. data/man/uffizzi.ronn +0 -45
data/man/uffizzi-config DELETED
@@ -1,65 +0,0 @@
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
-
@@ -1,55 +0,0 @@
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
data/man/uffizzi-connect DELETED
@@ -1,40 +0,0 @@
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\.
@@ -1,37 +0,0 @@
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
@@ -1,42 +0,0 @@
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`
@@ -1,34 +0,0 @@
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
@@ -1,39 +0,0 @@
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`
@@ -1,37 +0,0 @@
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
@@ -1,41 +0,0 @@
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`
@@ -1,37 +0,0 @@
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
@@ -1,42 +0,0 @@
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`
@@ -1,31 +0,0 @@
1
- .\" generated with Ronn-NG/v0.9.1
2
- .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-CONNECT\-GCR" "" "August 2023" ""
4
- .SH "NAME"
5
- \fBuffizzi\-connect\-gcr\fR \- grant a Uffizzi user account access to a private Google Container Registry (GCR)
6
- .SH "SYNOPSIS"
7
- \fBuffizzi connect gcr\fR [KEY_FILE]
8
- .SH "DESCRIPTION"
9
- Given valid credentials, grants a Uffizzi user account access to a private Google Container Registry
10
- .P
11
- Credentials can be provided via a key file or environment variable:
12
- .br
13
- \fBGCLOUD_SERVICE_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 "ARGUMENTS"
25
- .TP
26
- KEY_FILE
27
- A Google Cloud service account key file\. The key file is a JSON file that grants Uffizzi access to a private GCR\.
28
- .SH "EXAMPLES"
29
- The following command uses a Google Cloud service account key file called sa\-private\-key\.json to connect to a private GCR:
30
- .P
31
- \fBuffizzi connect gcr sa\-private\-key\.json\fR
@@ -1,36 +0,0 @@
1
- # uffizzi-connect-gcr - grant a Uffizzi user account access to a private Google Container Registry (GCR)
2
-
3
- ## SYNOPSIS
4
-
5
- `uffizzi connect gcr` [KEY_FILE]
6
-
7
- ## DESCRIPTION
8
-
9
- Given valid credentials, grants a Uffizzi user account access
10
- to a private Google Container Registry
11
-
12
- Credentials can be provided via a key file or environment variable:
13
- `GCLOUD_SERVICE_KEY`
14
-
15
- This command can fail for the following reasons:
16
- - The active user does not have permission to connect external services.
17
- - The given credentials are invalid.
18
-
19
- For more information on connecting to external services, see:
20
- https://docs.uffizzi.com/references/cli/
21
-
22
- For detailed instructions on configuring webhooks to send push
23
- notifications to Uffizzi, see:
24
- https://docs.uffizzi.com/guides/container-registry-integrations
25
-
26
- ## ARGUMENTS
27
-
28
- * KEY_FILE:
29
- A Google Cloud service account key file. The key file is a JSON file that grants Uffizzi access to a private GCR.
30
-
31
- ## EXAMPLES
32
-
33
- The following command uses a Google Cloud service account key
34
- file called sa-private-key.json to connect to a private GCR:
35
-
36
- `uffizzi connect gcr sa-private-key.json`
@@ -1,34 +0,0 @@
1
- .\" generated with Ronn-NG/v0.9.1
2
- .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
3
- .TH "UFFIZZI\-CONNECT\-GHCR" "" "August 2023" ""
4
- .SH "NAME"
5
- \fBuffizzi\-connect\-ghcr\fR \- grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
6
- .SH "SYNOPSIS"
7
- \fBuffizzi connect ghcr\fR [\-\-username=USERNAME] [\-\-token=TOKEN]
8
- .SH "DESCRIPTION"
9
- Given valid credentials, grants a Uffizzi user account access to a private GitHub Container Registry\.
10
- .P
11
- Credentials can be provided interactively or non\-interactively via command options or environment variables:
12
- .br
13
- \fBGITHUB_USERNAME\fR, \fBGITHUB_ACCESS_TOKEN\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\-t\fR, \fB\-\-token=<token>\fR
30
- Access token for the service\.
31
- .SH "EXAMPLES"
32
- The following command will prompt the user to enter GHCR credentials, including GitHub account name and personal access token (PAT):
33
- .P
34
- \fBuffizzi connect ghcr\fR
@@ -1,40 +0,0 @@
1
- # uffizzi-connect-ghcr - grant a Uffizzi user account access to a private GitHub Container Registry (GHCR)
2
-
3
- ## SYNOPSIS
4
-
5
- `uffizzi connect ghcr` [--username=USERNAME] [--token=TOKEN]
6
-
7
- ## DESCRIPTION
8
-
9
- Given valid credentials, grants a Uffizzi user account access
10
- to a private GitHub Container Registry.
11
-
12
- Credentials can be provided interactively or non-interactively
13
- via command options or environment variables:
14
- `GITHUB_USERNAME`, `GITHUB_ACCESS_TOKEN`
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
- * `-t`, `--token=<token>`:
32
- Access token for the service.
33
-
34
- ## EXAMPLES
35
-
36
- The following command will prompt the user to enter GHCR
37
- credentials, including GitHub account name and
38
- personal access token (PAT):
39
-
40
- `uffizzi connect ghcr`
@@ -1,45 +0,0 @@
1
- # uffizzi-connect - grant a Uffizzi user account access to external services
2
-
3
- ## SYNOPSIS
4
-
5
- `uffizzi connect` COMMAND [--skip-raise-existence-error] [--update-credential-if-exists]
6
-
7
- ## DESCRIPTION
8
-
9
- Grants a Uffizzi user account access to external services.
10
-
11
- For more information on connecting to external services, see:
12
- https://docs.uffizzi.com/references/cli/
13
-
14
- ## COMMANDS
15
-
16
- COMMAND is one of the following:
17
-
18
- * `acr`:
19
- Connect to Azure Container Registry (azurecr.io).
20
-
21
- * `docker-hub`:
22
- Connect to Docker Hub (hub.docker.com).
23
-
24
- * `docker-registry`:
25
- Connect to any registry implementing the Docker Registry HTTP API protocol
26
-
27
- * `ecr`:
28
- Connect to Amazon Elastic Container Registry (amazonaws.com).
29
-
30
- * `gcr`:
31
- Connect to Google Container Registry (gcr.io).
32
-
33
- * `ghcr`:
34
- Connect to GitHub Container Registry (ghcr.io).
35
-
36
-
37
- ## FLAGS
38
-
39
- * `--skip-raise-existence-error`:
40
- If credential exists, do not raise an exception, just print a message.
41
-
42
- * `--update-credential-if-exists`:
43
- Update credential if it exists.
44
-
45
- Run `uffizzi connect COMMAND --help` for more information on a command.