Skip to content
This repository was archived by the owner on Feb 13, 2025. It is now read-only.

Commit f7a4cb6

Browse files
authored
Merge pull request #3533 from M7mdisk/add-md-files
Add markdown files
2 parents bece7bf + c0d1c21 commit f7a4cb6

File tree

566 files changed

+82346
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

566 files changed

+82346
-0
lines changed

tmp/t/10045.md

+207
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
system | 2024-09-16 15:52:45 UTC | #1
2+
3+
[note type=caution]
4+
The information in this doc is based on Juju version 3.5.5,
5+
and may not accurately reflect other versions of Juju.
6+
[/note]
7+
8+
# Index
9+
0. [actions](/t/10069)
10+
1. [add-cloud](/t/10162)
11+
2. [add-credential](/t/10136)
12+
3. [add-k8s](/t/10049)
13+
4. [add-machine](/t/10071)
14+
5. [add-model](/t/10145)
15+
6. [add-secret](/t/11144)
16+
7. [add-secret-backend](/t/10062)
17+
8. [add-space](/t/10117)
18+
9. [add-ssh-key](/t/10238)
19+
10. [add-storage](/t/10159)
20+
11. [add-unit](/t/10141)
21+
12. [add-user](/t/10193)
22+
13. [agree](/t/10161)
23+
14. [agreements](/t/10064)
24+
15. [attach-resource](/t/10124)
25+
16. [attach-storage](/t/10126)
26+
17. [autoload-credentials](/t/10230)
27+
18. [bind](/t/10244)
28+
19. [bootstrap](/t/10132)
29+
20. [cancel-task](/t/10053)
30+
21. [change-user-password](/t/10118)
31+
22. [charm-resources](/t/10099)
32+
23. [clouds](/t/10182)
33+
24. [collect-metrics](/t/10085)
34+
25. [config](/t/10139)
35+
26. [constraints](/t/10060)
36+
27. [consume](/t/10213)
37+
28. [controller-config](/t/10237)
38+
29. [controllers](/t/10152)
39+
30. [create-backup](/t/10197)
40+
31. [create-storage-pool](/t/10093)
41+
32. [credentials](/t/10054)
42+
33. [dashboard](/t/10091)
43+
34. [debug-code](/t/10048)
44+
35. [debug-hook](/t/10229)
45+
36. [debug-hooks](/t/10242)
46+
37. [debug-log](/t/10116)
47+
38. [default-credential](/t/10055)
48+
39. [default-region](/t/10082)
49+
40. [deploy](/t/10074)
50+
41. [destroy-controller](/t/10113)
51+
42. [destroy-model](/t/10190)
52+
43. [detach-storage](/t/10089)
53+
44. [diff-bundle](/t/10142)
54+
45. [disable-command](/t/10205)
55+
46. [disable-user](/t/10198)
56+
47. [disabled-commands](/t/10220)
57+
49. [download](/t/10134)
58+
50. [download-backup](/t/10240)
59+
51. [enable-command](/t/10111)
60+
52. [enable-destroy-controller](/t/10086)
61+
53. [enable-ha](/t/10206)
62+
54. [enable-user](/t/10241)
63+
55. [exec](/t/10195)
64+
56. [export-bundle](/t/10046)
65+
57. [expose](/t/10109)
66+
58. [find](/t/10187)
67+
59. [find-offers](/t/10097)
68+
60. [firewall-rules](/t/10061)
69+
61. [grant](/t/10196)
70+
62. [grant-cloud](/t/10164)
71+
63. [grant-secret](/t/11290)
72+
65. [help-tool](/t/10050)
73+
66. [import-filesystem](/t/10047)
74+
67. [import-ssh-key](/t/10167)
75+
68. [info](/t/10103)
76+
69. [integrate](/t/10207)
77+
70. [kill-controller](/t/10233)
78+
71. [list-actions](/t/10232)
79+
72. [list-agreements](/t/10200)
80+
73. [list-charm-resources](/t/10234)
81+
74. [list-clouds](/t/10199)
82+
75. [list-controllers](/t/10079)
83+
76. [list-credentials](/t/10150)
84+
77. [list-disabled-commands](/t/10094)
85+
78. [list-firewall-rules](/t/10114)
86+
79. [list-machines](/t/10181)
87+
80. [list-models](/t/10107)
88+
81. [list-offers](/t/10170)
89+
82. [list-operations](/t/10158)
90+
83. [list-payloads](/t/10070)
91+
84. [list-regions](/t/10131)
92+
85. [list-resources](/t/10056)
93+
86. [list-secret-backends](/t/10072)
94+
87. [list-secrets](/t/10108)
95+
88. [list-spaces](/t/10100)
96+
89. [list-ssh-keys](/t/10133)
97+
90. [list-storage](/t/10138)
98+
91. [list-storage-pools](/t/10211)
99+
92. [list-subnets](/t/10076)
100+
93. [list-users](/t/10154)
101+
94. [login](/t/10157)
102+
95. [logout](/t/10183)
103+
96. [machines](/t/10078)
104+
97. [metrics](/t/10143)
105+
98. [migrate](/t/10121)
106+
99. [model-config](/t/10096)
107+
100. [model-constraints](/t/10137)
108+
101. [model-default](/t/10178)
109+
102. [model-defaults](/t/10057)
110+
103. [models](/t/10090)
111+
104. [move-to-space](/t/10192)
112+
105. [offer](/t/10080)
113+
106. [offers](/t/10051)
114+
107. [operations](/t/10203)
115+
108. [payloads](/t/10120)
116+
109. [refresh](/t/10189)
117+
110. [regions](/t/10112)
118+
111. [register](/t/10160)
119+
112. [relate](/t/10140)
120+
113. [reload-spaces](/t/10063)
121+
114. [remove-application](/t/10067)
122+
115. [remove-cloud](/t/10216)
123+
116. [remove-credential](/t/10201)
124+
117. [remove-k8s](/t/10098)
125+
118. [remove-machine](/t/10163)
126+
119. [remove-offer](/t/10235)
127+
120. [remove-relation](/t/10110)
128+
121. [remove-saas](/t/10087)
129+
122. [remove-secret](/t/11414)
130+
123. [remove-secret-backend](/t/10194)
131+
124. [remove-space](/t/10084)
132+
125. [remove-ssh-key](/t/10119)
133+
126. [remove-storage](/t/10066)
134+
127. [remove-storage-pool](/t/10068)
135+
128. [remove-unit](/t/10125)
136+
129. [remove-user](/t/10130)
137+
130. [rename-space](/t/10135)
138+
131. [resolve](/t/10146)
139+
132. [resolved](/t/10144)
140+
133. [resources](/t/10218)
141+
134. [resume-relation](/t/10123)
142+
135. [retry-provisioning](/t/10209)
143+
136. [revoke](/t/10077)
144+
137. [revoke-cloud](/t/10104)
145+
138. [revoke-secret](/t/11291)
146+
139. [run](/t/10052)
147+
140. [scale-application](/t/10171)
148+
141. [scp](/t/10128)
149+
142. [secret-backends](/t/10149)
150+
143. [secrets](/t/10214)
151+
144. [set-application-base](/t/10174)
152+
145. [set-constraints](/t/10210)
153+
146. [set-credential](/t/10169)
154+
147. [set-default-credentials](/t/10180)
155+
148. [set-default-region](/t/10092)
156+
149. [set-firewall-rule](/t/10151)
157+
150. [set-meter-status](/t/10166)
158+
151. [set-model-constraints](/t/10208)
159+
152. [show-action](/t/10219)
160+
153. [show-application](/t/10177)
161+
154. [show-cloud](/t/10215)
162+
155. [show-controller](/t/10156)
163+
156. [show-credential](/t/10105)
164+
157. [show-credentials](/t/10147)
165+
158. [show-machine](/t/10243)
166+
159. [show-model](/t/10191)
167+
160. [show-offer](/t/10168)
168+
161. [show-operation](/t/10083)
169+
162. [show-secret](/t/10172)
170+
163. [show-secret-backend](/t/10059)
171+
164. [show-space](/t/10095)
172+
165. [show-status-log](/t/10204)
173+
166. [show-storage](/t/10184)
174+
167. [show-task](/t/10129)
175+
168. [show-unit](/t/10239)
176+
169. [show-user](/t/10212)
177+
170. [spaces](/t/10236)
178+
171. [ssh](/t/10153)
179+
172. [ssh-keys](/t/10202)
180+
173. [status](/t/10173)
181+
174. [storage](/t/10075)
182+
175. [storage-pools](/t/10228)
183+
176. [subnets](/t/10186)
184+
177. [suspend-relation](/t/10179)
185+
178. [switch](/t/10102)
186+
179. [sync-agent-binary](/t/10106)
187+
180. [trust](/t/10088)
188+
181. [unexpose](/t/10221)
189+
182. [unregister](/t/10165)
190+
183. [update-cloud](/t/10081)
191+
184. [update-credential](/t/10065)
192+
185. [update-credentials](/t/10231)
193+
186. [update-k8s](/t/10155)
194+
187. [update-public-clouds](/t/10115)
195+
188. [update-secret](/t/11413)
196+
189. [update-secret-backend](/t/10176)
197+
190. [update-storage-pool](/t/10217)
198+
191. [upgrade-controller](/t/10058)
199+
192. [upgrade-machine](/t/10188)
200+
193. [upgrade-model](/t/10073)
201+
194. [users](/t/10175)
202+
196. [wait-for](/t/10122)
203+
197. [whoami](/t/10148)
204+
---
205+
206+
-------------------------
207+

tmp/t/10046.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
system | 2024-09-16 15:57:20 UTC | #1
2+
3+
[note type=caution]
4+
The information in this doc is based on Juju version 3.5.5,
5+
and may not accurately reflect other versions of Juju.
6+
[/note]
7+
8+
9+
## Summary
10+
Exports the current model configuration as a reusable bundle.
11+
12+
### Options
13+
| Flag | Default | Usage |
14+
| --- | --- | --- |
15+
| `-B`, `--no-browser-login` | false | Do not use web browser for authentication |
16+
| `--filename` | | Bundle file |
17+
| `--include-charm-defaults` | false | Whether to include charm config default values in the exported bundle |
18+
| `--include-series` | false | Comaptibility option. Set to include series in the bundle alongside bases |
19+
| `-m`, `--model` | | Model to operate in. Accepts [<controller name>:]<model name>|<model UUID> |
20+
21+
## Examples
22+
23+
juju export-bundle
24+
juju export-bundle --filename mymodel.yaml
25+
juju export-bundle --include-charm-defaults
26+
juju export-bundle --include-series
27+
28+
29+
## Details
30+
31+
Exports the current model configuration as a reusable bundle.
32+
33+
If --filename is not used, the configuration is printed to stdout.
34+
--filename specifies an output file.
35+
36+
If --include-series is used, the exported bundle will include the OS series
37+
alongside bases. This should be used as a compatibility option for older
38+
versions of Juju before bases were added.
39+
40+
41+
---
42+
43+
-------------------------
44+

tmp/t/10047.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
system | 2024-09-16 15:55:53 UTC | #1
2+
3+
[note type=caution]
4+
The information in this doc is based on Juju version 3.5.5,
5+
and may not accurately reflect other versions of Juju.
6+
[/note]
7+
8+
> See also: [storage](/t/10075)
9+
10+
## Summary
11+
Imports a filesystem into the model.
12+
13+
## Usage
14+
```juju import-filesystem [options]
15+
<storage-provider> <provider-id> <storage-name>
16+
```
17+
18+
### Options
19+
| Flag | Default | Usage |
20+
| --- | --- | --- |
21+
| `-B`, `--no-browser-login` | false | Do not use web browser for authentication |
22+
| `-m`, `--model` | | Model to operate in. Accepts [&lt;controller name&gt;:]&lt;model name&gt;&#x7c;&lt;model UUID&gt; |
23+
24+
## Examples
25+
26+
Import an existing filesystem backed by an EBS volume,
27+
and assign it the "pgdata" storage name. Juju will
28+
associate a storage instance ID like "pgdata/0" with
29+
the volume and filesystem contained within.
30+
31+
juju import-filesystem ebs vol-123456 pgdata
32+
33+
34+
35+
## Details
36+
37+
Import an existing filesystem into the model. This will lead to the model
38+
taking ownership of the storage, so you must take care not to import storage
39+
that is in use by another Juju model.
40+
41+
To import a filesystem, you must specify three things:
42+
43+
- the storage provider which manages the storage, and with
44+
which the storage will be associated
45+
- the storage provider ID for the filesystem, or
46+
volume that backs the filesystem
47+
- the storage name to assign to the filesystem,
48+
corresponding to the storage name used by a charm
49+
50+
Once a filesystem is imported, Juju will create an associated storage
51+
instance using the given storage name.
52+
53+
54+
---
55+
56+
-------------------------
57+

tmp/t/10048.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
system | 2024-09-16 15:57:41 UTC | #1
2+
3+
[note type=caution]
4+
The information in this doc is based on Juju version 3.5.5,
5+
and may not accurately reflect other versions of Juju.
6+
[/note]
7+
8+
> See also: [ssh](/t/10153), [debug-hooks](/t/10242)
9+
10+
## Summary
11+
Launch a tmux session to debug hooks and/or actions.
12+
13+
## Usage
14+
```juju debug-code [options] <unit name> [hook or action names]```
15+
16+
### Options
17+
| Flag | Default | Usage |
18+
| --- | --- | --- |
19+
| `--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' |
20+
| `--container` | | the container name of the target pod |
21+
| `-m`, `--model` | | Model to operate in. Accepts [&lt;controller name&gt;:]&lt;model name&gt;&#x7c;&lt;model UUID&gt; |
22+
| `--no-host-key-checks` | false | Skip host key checking (INSECURE) |
23+
| `--proxy` | false | Proxy through the API server |
24+
| `--pty` | &lt;auto&gt; | Enable pseudo-tty allocation |
25+
| `--remote` | false | Target on the workload or operator pod (k8s-only) |
26+
27+
## Examples
28+
29+
Debug all hooks and actions of unit '0':
30+
31+
juju debug-code mysql/0
32+
33+
Debug all hooks and actions of the leader:
34+
35+
juju debug-code mysql/leader
36+
37+
Debug the 'config-changed' hook of unit '1':
38+
39+
juju debug-code mysql/1 config-changed
40+
41+
Debug the 'pull-site' action and 'update-status' hook:
42+
43+
juju debug-code hello-kubecon/0 pull-site update-status
44+
45+
Debug the 'leader-elected' hook and set 'JUJU_DEBUG_AT' variable to 'hook':
46+
47+
juju debug-code --at=hook mysql/0 leader-elected
48+
49+
50+
## Details
51+
52+
The command launches a tmux session that will intercept matching hooks and/or
53+
actions.
54+
55+
Initially, the tmux session will take you to '/var/lib/juju' or '/home/ubuntu'.
56+
As soon as a matching hook or action is fired, the hook or action is executed
57+
and the JUJU_DEBUG_AT variable is set. Charms implementing support for this
58+
should set debug breakpoints based on the environment variable. Charms written
59+
with the Charmed Operator Framework Ops automatically provide support for this.
60+
61+
For more details on debugging charm code, see the charm SDK documentation.
62+
63+
Valid unit identifiers are:
64+
a standard unit ID, such as mysql/0 or;
65+
leader syntax of the form &lt;application&gt;/leader, such as mysql/leader.
66+
67+
If no hook or action is specified, all hooks and actions will be intercepted.
68+
69+
See the "juju help ssh" for information about SSH related options
70+
accepted by the debug-code command.
71+
72+
73+
---
74+
75+
-------------------------
76+

0 commit comments

Comments
 (0)