-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3533 from M7mdisk/add-md-files
Add markdown files
- Loading branch information
Showing
566 changed files
with
82,346 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,207 @@ | ||
system | 2024-09-16 15:52:45 UTC | #1 | ||
|
||
[note type=caution] | ||
The information in this doc is based on Juju version 3.5.5, | ||
and may not accurately reflect other versions of Juju. | ||
[/note] | ||
|
||
# Index | ||
0. [actions](/t/10069) | ||
1. [add-cloud](/t/10162) | ||
2. [add-credential](/t/10136) | ||
3. [add-k8s](/t/10049) | ||
4. [add-machine](/t/10071) | ||
5. [add-model](/t/10145) | ||
6. [add-secret](/t/11144) | ||
7. [add-secret-backend](/t/10062) | ||
8. [add-space](/t/10117) | ||
9. [add-ssh-key](/t/10238) | ||
10. [add-storage](/t/10159) | ||
11. [add-unit](/t/10141) | ||
12. [add-user](/t/10193) | ||
13. [agree](/t/10161) | ||
14. [agreements](/t/10064) | ||
15. [attach-resource](/t/10124) | ||
16. [attach-storage](/t/10126) | ||
17. [autoload-credentials](/t/10230) | ||
18. [bind](/t/10244) | ||
19. [bootstrap](/t/10132) | ||
20. [cancel-task](/t/10053) | ||
21. [change-user-password](/t/10118) | ||
22. [charm-resources](/t/10099) | ||
23. [clouds](/t/10182) | ||
24. [collect-metrics](/t/10085) | ||
25. [config](/t/10139) | ||
26. [constraints](/t/10060) | ||
27. [consume](/t/10213) | ||
28. [controller-config](/t/10237) | ||
29. [controllers](/t/10152) | ||
30. [create-backup](/t/10197) | ||
31. [create-storage-pool](/t/10093) | ||
32. [credentials](/t/10054) | ||
33. [dashboard](/t/10091) | ||
34. [debug-code](/t/10048) | ||
35. [debug-hook](/t/10229) | ||
36. [debug-hooks](/t/10242) | ||
37. [debug-log](/t/10116) | ||
38. [default-credential](/t/10055) | ||
39. [default-region](/t/10082) | ||
40. [deploy](/t/10074) | ||
41. [destroy-controller](/t/10113) | ||
42. [destroy-model](/t/10190) | ||
43. [detach-storage](/t/10089) | ||
44. [diff-bundle](/t/10142) | ||
45. [disable-command](/t/10205) | ||
46. [disable-user](/t/10198) | ||
47. [disabled-commands](/t/10220) | ||
49. [download](/t/10134) | ||
50. [download-backup](/t/10240) | ||
51. [enable-command](/t/10111) | ||
52. [enable-destroy-controller](/t/10086) | ||
53. [enable-ha](/t/10206) | ||
54. [enable-user](/t/10241) | ||
55. [exec](/t/10195) | ||
56. [export-bundle](/t/10046) | ||
57. [expose](/t/10109) | ||
58. [find](/t/10187) | ||
59. [find-offers](/t/10097) | ||
60. [firewall-rules](/t/10061) | ||
61. [grant](/t/10196) | ||
62. [grant-cloud](/t/10164) | ||
63. [grant-secret](/t/11290) | ||
65. [help-tool](/t/10050) | ||
66. [import-filesystem](/t/10047) | ||
67. [import-ssh-key](/t/10167) | ||
68. [info](/t/10103) | ||
69. [integrate](/t/10207) | ||
70. [kill-controller](/t/10233) | ||
71. [list-actions](/t/10232) | ||
72. [list-agreements](/t/10200) | ||
73. [list-charm-resources](/t/10234) | ||
74. [list-clouds](/t/10199) | ||
75. [list-controllers](/t/10079) | ||
76. [list-credentials](/t/10150) | ||
77. [list-disabled-commands](/t/10094) | ||
78. [list-firewall-rules](/t/10114) | ||
79. [list-machines](/t/10181) | ||
80. [list-models](/t/10107) | ||
81. [list-offers](/t/10170) | ||
82. [list-operations](/t/10158) | ||
83. [list-payloads](/t/10070) | ||
84. [list-regions](/t/10131) | ||
85. [list-resources](/t/10056) | ||
86. [list-secret-backends](/t/10072) | ||
87. [list-secrets](/t/10108) | ||
88. [list-spaces](/t/10100) | ||
89. [list-ssh-keys](/t/10133) | ||
90. [list-storage](/t/10138) | ||
91. [list-storage-pools](/t/10211) | ||
92. [list-subnets](/t/10076) | ||
93. [list-users](/t/10154) | ||
94. [login](/t/10157) | ||
95. [logout](/t/10183) | ||
96. [machines](/t/10078) | ||
97. [metrics](/t/10143) | ||
98. [migrate](/t/10121) | ||
99. [model-config](/t/10096) | ||
100. [model-constraints](/t/10137) | ||
101. [model-default](/t/10178) | ||
102. [model-defaults](/t/10057) | ||
103. [models](/t/10090) | ||
104. [move-to-space](/t/10192) | ||
105. [offer](/t/10080) | ||
106. [offers](/t/10051) | ||
107. [operations](/t/10203) | ||
108. [payloads](/t/10120) | ||
109. [refresh](/t/10189) | ||
110. [regions](/t/10112) | ||
111. [register](/t/10160) | ||
112. [relate](/t/10140) | ||
113. [reload-spaces](/t/10063) | ||
114. [remove-application](/t/10067) | ||
115. [remove-cloud](/t/10216) | ||
116. [remove-credential](/t/10201) | ||
117. [remove-k8s](/t/10098) | ||
118. [remove-machine](/t/10163) | ||
119. [remove-offer](/t/10235) | ||
120. [remove-relation](/t/10110) | ||
121. [remove-saas](/t/10087) | ||
122. [remove-secret](/t/11414) | ||
123. [remove-secret-backend](/t/10194) | ||
124. [remove-space](/t/10084) | ||
125. [remove-ssh-key](/t/10119) | ||
126. [remove-storage](/t/10066) | ||
127. [remove-storage-pool](/t/10068) | ||
128. [remove-unit](/t/10125) | ||
129. [remove-user](/t/10130) | ||
130. [rename-space](/t/10135) | ||
131. [resolve](/t/10146) | ||
132. [resolved](/t/10144) | ||
133. [resources](/t/10218) | ||
134. [resume-relation](/t/10123) | ||
135. [retry-provisioning](/t/10209) | ||
136. [revoke](/t/10077) | ||
137. [revoke-cloud](/t/10104) | ||
138. [revoke-secret](/t/11291) | ||
139. [run](/t/10052) | ||
140. [scale-application](/t/10171) | ||
141. [scp](/t/10128) | ||
142. [secret-backends](/t/10149) | ||
143. [secrets](/t/10214) | ||
144. [set-application-base](/t/10174) | ||
145. [set-constraints](/t/10210) | ||
146. [set-credential](/t/10169) | ||
147. [set-default-credentials](/t/10180) | ||
148. [set-default-region](/t/10092) | ||
149. [set-firewall-rule](/t/10151) | ||
150. [set-meter-status](/t/10166) | ||
151. [set-model-constraints](/t/10208) | ||
152. [show-action](/t/10219) | ||
153. [show-application](/t/10177) | ||
154. [show-cloud](/t/10215) | ||
155. [show-controller](/t/10156) | ||
156. [show-credential](/t/10105) | ||
157. [show-credentials](/t/10147) | ||
158. [show-machine](/t/10243) | ||
159. [show-model](/t/10191) | ||
160. [show-offer](/t/10168) | ||
161. [show-operation](/t/10083) | ||
162. [show-secret](/t/10172) | ||
163. [show-secret-backend](/t/10059) | ||
164. [show-space](/t/10095) | ||
165. [show-status-log](/t/10204) | ||
166. [show-storage](/t/10184) | ||
167. [show-task](/t/10129) | ||
168. [show-unit](/t/10239) | ||
169. [show-user](/t/10212) | ||
170. [spaces](/t/10236) | ||
171. [ssh](/t/10153) | ||
172. [ssh-keys](/t/10202) | ||
173. [status](/t/10173) | ||
174. [storage](/t/10075) | ||
175. [storage-pools](/t/10228) | ||
176. [subnets](/t/10186) | ||
177. [suspend-relation](/t/10179) | ||
178. [switch](/t/10102) | ||
179. [sync-agent-binary](/t/10106) | ||
180. [trust](/t/10088) | ||
181. [unexpose](/t/10221) | ||
182. [unregister](/t/10165) | ||
183. [update-cloud](/t/10081) | ||
184. [update-credential](/t/10065) | ||
185. [update-credentials](/t/10231) | ||
186. [update-k8s](/t/10155) | ||
187. [update-public-clouds](/t/10115) | ||
188. [update-secret](/t/11413) | ||
189. [update-secret-backend](/t/10176) | ||
190. [update-storage-pool](/t/10217) | ||
191. [upgrade-controller](/t/10058) | ||
192. [upgrade-machine](/t/10188) | ||
193. [upgrade-model](/t/10073) | ||
194. [users](/t/10175) | ||
196. [wait-for](/t/10122) | ||
197. [whoami](/t/10148) | ||
--- | ||
|
||
------------------------- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
system | 2024-09-16 15:57:20 UTC | #1 | ||
|
||
[note type=caution] | ||
The information in this doc is based on Juju version 3.5.5, | ||
and may not accurately reflect other versions of Juju. | ||
[/note] | ||
|
||
|
||
## Summary | ||
Exports the current model configuration as a reusable bundle. | ||
|
||
### Options | ||
| Flag | Default | Usage | | ||
| --- | --- | --- | | ||
| `-B`, `--no-browser-login` | false | Do not use web browser for authentication | | ||
| `--filename` | | Bundle file | | ||
| `--include-charm-defaults` | false | Whether to include charm config default values in the exported bundle | | ||
| `--include-series` | false | Comaptibility option. Set to include series in the bundle alongside bases | | ||
| `-m`, `--model` | | Model to operate in. Accepts [<controller name>:]<model name>|<model UUID> | | ||
|
||
## Examples | ||
|
||
juju export-bundle | ||
juju export-bundle --filename mymodel.yaml | ||
juju export-bundle --include-charm-defaults | ||
juju export-bundle --include-series | ||
|
||
|
||
## Details | ||
|
||
Exports the current model configuration as a reusable bundle. | ||
|
||
If --filename is not used, the configuration is printed to stdout. | ||
--filename specifies an output file. | ||
|
||
If --include-series is used, the exported bundle will include the OS series | ||
alongside bases. This should be used as a compatibility option for older | ||
versions of Juju before bases were added. | ||
|
||
|
||
--- | ||
|
||
------------------------- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
system | 2024-09-16 15:55:53 UTC | #1 | ||
|
||
[note type=caution] | ||
The information in this doc is based on Juju version 3.5.5, | ||
and may not accurately reflect other versions of Juju. | ||
[/note] | ||
|
||
> See also: [storage](/t/10075) | ||
## Summary | ||
Imports a filesystem into the model. | ||
|
||
## Usage | ||
```juju import-filesystem [options] | ||
<storage-provider> <provider-id> <storage-name> | ||
``` | ||
|
||
### Options | ||
| Flag | Default | Usage | | ||
| --- | --- | --- | | ||
| `-B`, `--no-browser-login` | false | Do not use web browser for authentication | | ||
| `-m`, `--model` | | Model to operate in. Accepts [<controller name>:]<model name>|<model UUID> | | ||
|
||
## Examples | ||
|
||
Import an existing filesystem backed by an EBS volume, | ||
and assign it the "pgdata" storage name. Juju will | ||
associate a storage instance ID like "pgdata/0" with | ||
the volume and filesystem contained within. | ||
|
||
juju import-filesystem ebs vol-123456 pgdata | ||
|
||
|
||
|
||
## Details | ||
|
||
Import an existing filesystem into the model. This will lead to the model | ||
taking ownership of the storage, so you must take care not to import storage | ||
that is in use by another Juju model. | ||
|
||
To import a filesystem, you must specify three things: | ||
|
||
- the storage provider which manages the storage, and with | ||
which the storage will be associated | ||
- the storage provider ID for the filesystem, or | ||
volume that backs the filesystem | ||
- the storage name to assign to the filesystem, | ||
corresponding to the storage name used by a charm | ||
|
||
Once a filesystem is imported, Juju will create an associated storage | ||
instance using the given storage name. | ||
|
||
|
||
--- | ||
|
||
------------------------- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
system | 2024-09-16 15:57:41 UTC | #1 | ||
|
||
[note type=caution] | ||
The information in this doc is based on Juju version 3.5.5, | ||
and may not accurately reflect other versions of Juju. | ||
[/note] | ||
|
||
> See also: [ssh](/t/10153), [debug-hooks](/t/10242) | ||
## Summary | ||
Launch a tmux session to debug hooks and/or actions. | ||
|
||
## Usage | ||
```juju debug-code [options] <unit name> [hook or action names]``` | ||
|
||
### Options | ||
| Flag | Default | Usage | | ||
| --- | --- | --- | | ||
| `--at` | all | will set the JUJU_DEBUG_AT environment variable to this value, which will then be interpreted by the charm for where you want to stop, defaults to 'all' | | ||
| `--container` | | the container name of the target pod | | ||
| `-m`, `--model` | | Model to operate in. Accepts [<controller name>:]<model name>|<model UUID> | | ||
| `--no-host-key-checks` | false | Skip host key checking (INSECURE) | | ||
| `--proxy` | false | Proxy through the API server | | ||
| `--pty` | <auto> | Enable pseudo-tty allocation | | ||
| `--remote` | false | Target on the workload or operator pod (k8s-only) | | ||
|
||
## Examples | ||
|
||
Debug all hooks and actions of unit '0': | ||
|
||
juju debug-code mysql/0 | ||
|
||
Debug all hooks and actions of the leader: | ||
|
||
juju debug-code mysql/leader | ||
|
||
Debug the 'config-changed' hook of unit '1': | ||
|
||
juju debug-code mysql/1 config-changed | ||
|
||
Debug the 'pull-site' action and 'update-status' hook: | ||
|
||
juju debug-code hello-kubecon/0 pull-site update-status | ||
|
||
Debug the 'leader-elected' hook and set 'JUJU_DEBUG_AT' variable to 'hook': | ||
|
||
juju debug-code --at=hook mysql/0 leader-elected | ||
|
||
|
||
## Details | ||
|
||
The command launches a tmux session that will intercept matching hooks and/or | ||
actions. | ||
|
||
Initially, the tmux session will take you to '/var/lib/juju' or '/home/ubuntu'. | ||
As soon as a matching hook or action is fired, the hook or action is executed | ||
and the JUJU_DEBUG_AT variable is set. Charms implementing support for this | ||
should set debug breakpoints based on the environment variable. Charms written | ||
with the Charmed Operator Framework Ops automatically provide support for this. | ||
|
||
For more details on debugging charm code, see the charm SDK documentation. | ||
|
||
Valid unit identifiers are: | ||
a standard unit ID, such as mysql/0 or; | ||
leader syntax of the form <application>/leader, such as mysql/leader. | ||
|
||
If no hook or action is specified, all hooks and actions will be intercepted. | ||
|
||
See the "juju help ssh" for information about SSH related options | ||
accepted by the debug-code command. | ||
|
||
|
||
--- | ||
|
||
------------------------- | ||
|
Oops, something went wrong.