Skip to content

Commit fc11541

Browse files
authored
Added page outlining usage of plugins. (juju#1252)
* Added page outlining usage of plugins. * Update juju-plugins.md
1 parent 8a0a691 commit fc11541

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

src/en/juju-plugins.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
Title: Juju plugins
2+
3+
# Juju plugins
4+
5+
Plugins are commands which work with Juju, but which are not part of the core
6+
code. Some plugins are provided with your Juju install (e.g. 'juju-metadata')
7+
because they contain functionality essential to some operations, others are
8+
just useful tools created by the community.
9+
10+
## Community plugins
11+
12+
There is a github project collecting all sorts of useful plugins created for
13+
the Juju ecosystem. You can check out further documentation on the plugins
14+
and how to install them [on the Github project page][plugin].
15+
16+
## Running a plugin
17+
18+
A Juju plugin is any executable code in your $PATH which begins 'juju-'.
19+
Although you can run these independently of the Juju command line, Juju
20+
will also wrap these commands so they can be run within Juju. For example:
21+
22+
```bash
23+
juju-metadata generate
24+
```
25+
26+
Can be executed within Juju by entering:
27+
28+
```bash
29+
juju metadata generate
30+
```
31+
32+
### Switches, flags and arguments
33+
34+
There is potential confusion when a plugin accepts a switch or flag; Juju needs
35+
to be able to differentiate between options intended for Juju and ones intended
36+
for the plugin. In this case any options for the plugin should be preceeded by
37+
' -- '. For example:
38+
39+
```bash
40+
juju foo -- -bar --baz qux
41+
```
42+
43+
[plugin]: https://github.com/juju/plugins#install "Juju plugins on Github"

src/navigation.tpl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
<li><a href="juju-block.html">Restrict/block Juju commands</a></li>
5555
<li><a href="juju-centos.html">CentOS support</a></li>
5656
<li><a href="network-spaces.html">Network spaces</a></li>
57+
<li><a href="juju-plugins.html">Juju plugins</a></li>
5758
<li><a href="juju-misc.html">Miscellaneous</a></li>
5859
</ul>
5960
</li>

0 commit comments

Comments
 (0)