Difference between pages "GlusterFS" and "Help:Funtoo Editing Guidelines"

(Difference between pages)
 
(Displaying Source Code)
 
Line 1: Line 1:
{{Article
+
'''Thanks for your interest in contributing to the the Funtoo wiki!'''
|Author=Drobbins
+
__NOTOC__
 +
=== Types of Edits ===
 +
 
 +
Before we get started, let's review what changes are okay to make, and what changes are not okay:
 +
 
 +
{{TableStart}}
 +
<tr class="active"><th>Type of Change</th><th>Okay?</th></tr>
 +
<tr><td>Grammar/spelling fixes</td><td>Yes</td></tr>
 +
<tr><td>New wiki content</td><td>Yes</td></tr>
 +
<tr><td>New package information</td><td>Yes</td></tr>
 +
<tr><td>Adding to existing article</td><td>Maybe -- see below</td></tr>
 +
<tr><td>Adding missing/incomplete information</td><td>Yes</td></tr>
 +
<tr><td>Making corrections</td><td>Yes</td></tr>
 +
<tr class="danger"><td>Adding work-arounds to problems experienced</td><td>No - open bug first on [http://bugs.funtoo.org bug tracker].</td></tr>
 +
{{TableEnd}}
 +
 
 +
{{important|Note that if you experience some problem with Funtoo Linux, during installation or otherwise, the proper course of action is to not add a work-around to our documentation, but to ''open a bug on our bug tracker.'' This is important because the problem you experienced may be a legitimate bug and the solution may be to fix the bug rather than add a work-around to our documentation. We may end up fixing a bug, making a documentation fix, or possibly both.}}
 +
 
 +
=== Basics ===
 +
 
 +
Here is a list of basic wiki information that you will need to know to get started:
 +
 
 +
* First, to perform edits on the wiki, you must {{CreateAccount}} and log in.
 +
* You can create a new page by navigating to http://www.funtoo.org/New_Page_Name. Underscores are the equivalent of spaces. Then select "Create" under the "Actions" menu.
 +
* Whether creating a new page or editing an existing page by clicking "Edit", you will be presented with Web-based text editor that allows you to modify the ''wikitext'' of the page. The wikitext is rendered to produce the document you see when you view the page normally.
 +
* Another fun thing you can do is click on your name under the "Account" menu once you have logged in. This will bring you to your "User" page. Then click "Create with Form" unde the "Actions" menu and enter your geographic and other information. This will allow you to be displayed on our [[Usermap]] and will also allow your full name to be displayed on [[:Category:Ebuilds|Ebuild pages]] for which you are an author. It's generally a good idea to do this.
 +
 
 +
{{tip|The following sections document how to use wikitext and Funtoo templates on the Funtoo wiki.}}
 +
 
 +
=== Paragraphs ===
 +
 
 +
To create a new paragraph, insert a blank line between two lines of text. If a blank line doesn't exist between two lines of wikitext, they will be combined into a single flowing paragraph.
 +
 
 +
If you leave leading whitespace at the beginning of a line, MediaWiki will render it as pre-formatted text. Beware of this. Here's an example:
 +
 
 +
foobar
 +
 
 +
This can rear its ugly head when specifying template parameters, so you will get this:
 +
 
 +
{{note| ugh!}}
 +
 
 +
...instead of this:
 +
 
 +
{{note|This looks much better!}}
 +
 
 +
=== Page and Section Capitalization ===
 +
 
 +
In general, capitalize all words in page names and section heading except:
 +
* Articles: a, an, the
 +
* Coordinating Conjunctions: and, but, or, for, nor, etc.
 +
* Prepositions (fewer than five letters): on, at, to, from, by, etc.
 +
 
 +
=== Document Hierarchy ===
 +
 
 +
Use section headings to create a document hierarchy for your page. These will define the table of contents that appears at the top of the wiki page. Create chapters, sections and sub-sections as follows:
 +
 
 +
<pre>= Page Title =
 +
 
 +
== Chapter Title ==
 +
 
 +
=== Section Title ===
 +
 
 +
==== SubSection Title ====
 +
 
 +
</pre>
 +
 
 +
{{Note|By default, Table of Contents is disabled on the Funtoo wiki. If you would like to enable the TOC, you can place a <code><nowiki>__TOC__</nowiki></code> on a blank line where you'd like the Table of Contents to appear, or place <code><nowiki>__FORCETOC__</nowiki></code> on a blank line anywhere in the wikitext to force the TOC to appear at the top of the page.}}
 +
 
 +
In general, when creating new documents, it's best to use level-3 (three "="'s) Section Titles to break up content. Level-2 Section Titles are best used for major sections of larger documents. Use them infrequently. Level-1 Section Titles generally do not need to be used.
 +
 
 +
=== Links ===
 +
 
 +
Internal links to other wiki pages can be specified as <tt><nowiki>[[pagename]]</nowiki></tt>. To specify an alternate name for the link, use <tt><nowiki>[[pagename|my link name]]</nowiki></tt>.
 +
 
 +
For external links, use <tt><nowiki>[http://funtoo.org my link]</nowiki></tt> to specify a URL. If you want the URL to appear in the wikitext, you can specify it without brackets: http://forums.funtoo.org.
 +
 
 +
=== Lists ===
 +
 
 +
MediaWiki supports a number of list formats:
 +
 
 +
* Unordered List
 +
* Unordered Item 2
 +
** Unordered sub-item
 +
 
 +
# Ordered List
 +
# Ordered Item 2
 +
## Ordered sub-item
 +
 
 +
;Term: This is called a "definition list". It is used when defining various terms.
 +
 
 +
If you need to quote a portion of text from another site, use <tt><nowiki><blockquote></nowiki></tt> as follows:
 +
 
 +
<blockquote>
 +
Wikipedia (ˌwɪkɨˈpiːdiə/ or wɪkiˈpiːdiə/ wik-i-pee-dee-ə) is a collaboratively edited, multilingual, free-access, free content Internet encyclopedia that is supported and hosted by the non-profit Wikimedia Foundation. Volunteers worldwide collaboratively write Wikipedia's 30 million articles in 287 languages, including over 4.5 million in the English Wikipedia. Anyone who can access the site can edit almost any of its articles, which on the Internet comprise[4] the largest and most popular general reference work.[5][6][7][8][9] In February 2014, The New York Times reported that Wikipedia is ranked fifth globally among all websites stating, "With 18 billion page views and nearly 500 million unique visitors a month..., Wikipedia trails just Yahoo, Facebook, Microsoft and Google, the largest with 1.2 billion unique visitors."[10]
 +
</blockquote>
 +
 
 +
=== Literal Text and HTML Symbols ===
 +
 
 +
Here is wikitext for the section above, which I am displaying by placing the literal wikitext between a &#60;pre&#62; and &#60;/pre&#62; tag. If you want to disable wikitext processing for an inline span of text, use &#60;nowiki&#62; and &#60;/nowiki&#62;. If you want to print out a tag literally, use &amp;#60; and &amp;#62; (In the wikitext, I used &amp;amp;#60; and &amp;amp;#62 to display these!)
 +
 
 +
<pre>
 +
* Unordered List
 +
* Unordered Item 2
 +
** Unordered sub-item
 +
 
 +
# Ordered List
 +
# Ordered Item 2
 +
## Ordered sub-item
 +
 
 +
;Term: This is called a "definition list". It is used when defining various terms.
 +
 
 +
If you need to quote a portion of text from another site, use <tt><nowiki><blockquote></nowiki></tt> as follows:
 +
 
 +
<blockquote>
 +
Wikipedia (ˌwɪkɨˈpiːdiə/ or wɪkiˈpiːdiə/ wik-i-pee-dee-ə) is a collaboratively edited, multilingual, free-access,
 +
free content Internet encyclopedia that is supported and hosted by the non-profit Wikimedia Foundation. Volunteers
 +
worldwide collaboratively write Wikipedia's 30 million articles in 287 languages, including over 4.5 million in the
 +
English Wikipedia. Anyone who can access the site can edit almost any of its articles, which on the Internet
 +
comprise[4] the largest and most popular general reference work.[5][6][7][8][9] In February 2014, The New York
 +
Times reported that Wikipedia is ranked fifth globally among all websites stating, "With 18 billion page views
 +
and nearly 500 million unique visitors a month..., Wikipedia trails just Yahoo, Facebook, Microsoft and Google,
 +
the largest with 1.2 billion unique visitors."[10]
 +
</blockquote>
 +
</pre>
 +
 
 +
=== Linking to Packages ===
 +
 
 +
To link to a package page, use the <code>Package</code> template:
 +
 
 +
<pre><nowiki>
 +
{{Package|sys-apps/portage}}
 +
</nowiki></pre>
 +
 
 +
This template will create a link to the official wiki page for sys-apps/portage, and render using the official "English" page name, as follows:
 +
 
 +
{{Package|sys-apps/portage}}
 +
 
 +
If you specify a yet-to-be-documented ebuild, it will render like this (which is okay -- it will encourage people to document it):
 +
 
 +
{{Package|sys-foo/undocumented-ebuild}}
 +
 
 +
=== Tables ===
 +
 
 +
Instead of using traditional MediaWiki table wikitext, use the following format:
 +
 
 +
<pre>
 +
{{TableStart}}
 +
<tr class="info"><th>Header 1</th><th>Header 2</th></tr>
 +
<tr><td>Value 1</td><td>Value 2</td></tr>
 +
<tr><td>Value 3</td><td>Value 4</td></tr>
 +
{{TableEnd}}
 +
</pre>
 +
 
 +
This wil render as follows:
 +
 
 +
{{TableStart}}
 +
<tr class="info"><th>Header 1</th><th>Header 2</th></tr>
 +
<tr><td>Value 1</td><td>Value 2</td></tr>
 +
<tr><td>Value 3</td><td>Value 4</td></tr>
 +
{{TableEnd}}
 +
 
 +
{{tip|This table syntax has an added benefit of creating a responsive table that renders properly on mobile devices.}}
 +
 
 +
It is possible to use the following CSS classes with <code>tr</code> (rows) and <code>td/th</code> elements to color them as desired:
 +
 
 +
{{TableStart}}
 +
<tr class="active"><td>Class Name</td></tr>
 +
<tr class="success"><td>success</td></tr>
 +
<tr class="info"><td>info</td></tr>
 +
<tr class="warning"><td>warning</td></tr>
 +
<tr class="active"><td>active</td></tr>
 +
<tr class="danger"><td>danger</td></tr>
 +
{{TableEnd}}
 +
 
 +
=== Displaying Source Code ===
 +
 
 +
To display source code, use can use the file template, specifying a <tt>lang=</tt> parameter:
 +
 
 +
<pre>
 +
{{file|name=foobar|lang=python|desc=foobarosity|body=
 +
import system
 
}}
 
}}
== GlusterFS Distribution ==
+
</pre>
  
Below, we create a distributed volume using two bricks (XFS filesystems.) This spreads IO and files among two bricks.
+
This will produce:
  
<console>
+
{{file|name=foobar|lang=python|desc=foobarosity|body=
# ##i##gluster peer status
+
import system
No peers present
+
}}
# ##i##gluster peer probe rhs-lab2
+
Probe successful
+
# ##i##gluster peer status
+
Number of Peers: 1
+
  
Hostname: rhs-lab2
+
The parameters {{c|name}} (filename), {{c|lang}} (language for syntax highlighting) and {{c|desc}} (Description, appearing as a caption) are optional. For a list of supported languages, see [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages this list].
Uuid: 6b6c9ffc-da79-4d24-8325-086d44869338
+
State: Peer in Cluster (Connected)
+
# ##i##gluster peer probe rhs-lab3
+
Probe successful
+
# ##i##gluster peer probe rhs-lab4
+
Probe successful
+
# ##i##gluster peer status
+
Number of Peers: 3
+
  
Hostname: rhs-lab2
 
Uuid: 6b6c9ffc-da79-4d24-8325-086d44869338
 
State: Peer in Cluster (Connected)
 
  
Hostname: rhs-lab3
+
{{important|If you need to display the pipe ("{{!}}") character within the body of a file template, replace each "{{!}}" with <nowiki>{{!}}</nowiki> -- otherwise your file contents will not display properly. This is necessary because <nowiki>{{file}}</nowiki> is a template and the "{{!}}" character is used as a delimiter for arguments to the template.}}
Uuid: cbcd508e-5f80-4224-91df-fd5f8e12915d
+
State: Peer in Cluster (Connected)
+
  
Hostname: rhs-lab4
+
=== Displaying Text File Contents ===
Uuid: a02f68d8-88af-4b79-92d8-1057dd85af45
+
State: Peer in Cluster (Connected)
+
# ##i##gluster volume create dist rhs-lab1:/data/dist rhs-lab2:/data/dist
+
Creation of volume dist has been successful. Please start the volume to access data.
+
</console>
+
  
 +
For displaying the contents of non-programming language text files (like config files), you have two options. You can enclose your lines within <tt>&#60;pre&#62;</tt> tags, or use the new [[Template:File|file template]]. The file template is used like so:
 +
 +
<pre>
 +
{{file|name=/etc/foo.conf|desc=My foo.conf file|body=
 +
# /etc/host.conf:
 +
# $Header: /var/cvsroot/gentoo/src/patchsets/glibc/extra/etc/host.conf,v 1.1 2006/09/29
 +
}}
 +
</pre>
 +
 +
This will produce:
 +
 +
{{file|name=/etc/foo.conf|desc=My foo.conf file|body=
 +
# /etc/host.conf:
 +
# $Header: /var/cvsroot/gentoo/src/patchsets/glibc/extra/etc/host.conf,v 1.1 2006/09/29
 +
}}
 +
 +
=== Console ===
 +
To display console output, use the <tt>&#60;console&#62;</tt> tag:
 +
 +
For a root console:
 +
<pre>
 
<console>
 
<console>
# ##i##gluster volume info
+
###i## run a command as root
+
Volume Name: dist
+
Type: Distribute
+
Volume ID: f9758871-20dc-4728-9576-a5bb5b24ca4f
+
Status: Created
+
Number of Bricks: 2
+
Transport-type: tcp
+
Bricks:
+
Brick1: rhs-lab1:/data/dist
+
Brick2: rhs-lab2:/data/dist
+
 
</console>
 
</console>
 
+
</pre>
 +
Produces:
 
<console>
 
<console>
# ##i##gluster volume start dist
+
###i## run a command as root
Starting volume dist has been successful
+
 
</console>
 
</console>
  
 +
For a non-root console:
 +
<pre>
 
<console>
 
<console>
# ##i##gluster volume info
+
$ ##i##run a command as user
+
Volume Name: dist
+
Type: Distribute
+
Volume ID: f9758871-20dc-4728-9576-a5bb5b24ca4f
+
Status: Started
+
Number of Bricks: 2
+
Transport-type: tcp
+
Bricks:
+
Brick1: rhs-lab1:/data/dist
+
Brick2: rhs-lab2:/data/dist
+
 
</console>
 
</console>
 
+
</pre>
 +
Produces:
 
<console>
 
<console>
# ##i##mount -t glusterfs rhs-lab1:/dist /mnt/dist
+
$ ##i##run a command as user
 
</console>
 
</console>
  
== GlusterFS Mirroring ==
+
{{important|1=
 +
Note that we use a <tt>#</tt> prompt for <tt>root</tt> and a <tt>$</tt> prompt to denote a non-root user.}}
  
Below, we mirror data between two bricks (XFS volumes). This creates a redundant system and also allows for read performance to be improved.
+
{{important|The <tt>##i##</tt> text tags the rest of the line as being ''user input'' ("i" is for "input"). It is then highlighted in a noticeable color so it stands out from text that is not typed in by the user.}}
  
<console>
+
If you need to end highlighting of user input prior to the end of a line, use <code>##!i##</code> to mark the end of the highlighted area.
# ##i##gluster volume create mirror replica 2 rhs-lab1:/data/mirror rhs-lab2:/data/mirror
+
 
Creation of volume mirror has been successful. Please start the volume to access data.
+
The following special character sequences are also available:
# ##i##gluster volume start mirror
+
* <code>##g##</code> - Green
Starting volume mirror has been successful
+
* <code>##y##</code> - Yellow
# ##i##gluster volume info mirror
+
* <code>##bl##</code> - Blue
+
* <code>##r##</code> - Red
Volume Name: mirror
+
* <code>##b##</code> - Bold
Type: Replicate
+
 
Volume ID: 4edacef8-982c-46a9-be7e-29e34fa40f95
+
Please use the above coloring options sparingly. It is sometimes nice to use them to get wiki console output to match the colors that are displayed on a Linux console. Also note that for every color above, there is a matching <code>##!(colorcode)##</code> option to turn color off prior to end of line.
Status: Started
+
Number of Bricks: 1 x 2 = 2
+
Transport-type: tcp
+
Bricks:
+
Brick1: rhs-lab1:/data/mirror
+
Brick2: rhs-lab2:/data/mirror
+
# ##i##install -d /mnt/mirror
+
# ##i##mount -t glusterfs rhs-lab1:/mirror /mnt/mirror
+
  
 +
Here is an example of its use:<console>
 +
# ##i##bluetoothctl
 +
[##g##NEW##!g##] Controller 00:02:72:C9:62:65 antec [default]
 +
##bl##[bluetooth]##!bl###power on
 +
Changing power on succeeded
 +
##bl##[bluetooth]##!bl### ##i##agent on
 +
Agent registered
 +
##bl##[bluetooth]##!bl### ##i##scan on
 +
Discovery started
 +
##bl##[bluetooth]##!bl### ##i##devices
 +
Device 00:1F:20:3D:1E:75 Logitech K760
 +
##bl##[bluetooth]##!bl### ##i##pair 00:1F:20:3D:1E:75
 +
Attempting to pair with 00:1F:20:3D:1E:75
 +
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: yes
 +
##r##[agent]##!r## Passkey: 454358
 +
##r##[agent]##!r## Passkey: ##i##4##!i##54358
 +
##r##[agent]##!r## Passkey: ##i##45##!i##4358
 +
##r##[agent]##!r## Passkey: ##i##454##!i##358
 +
##r##[agent]##!r## Passkey: ##i##4543##!i##58
 +
##r##[agent]##!r## Passkey: ##i##45435##!i##8
 +
##r##[agent]##!r## Passkey: ##i##454358##!i##
 +
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Paired: yes
 +
Pairing successful
 +
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: no
 +
##bl##[bluetooth]##!bl### ##i##connect 00:1F:20:3D:1E:75
 +
Attempting to connect to 00:1F:20:3D:1E:75
 +
[##y##CHG##!y##] Device 00:1F:20:3D:1E:75 Connected: yes
 +
Connection successful
 +
##bl##[bluetooth]##!bl### ##i##quit
 +
[##r##DEL##!r##] Controller 00:02:72:C9:62:65 antec [default]
 +
#
 
</console>
 
</console>
  
== Growing GlusterFS ==
+
=== Informational Messages ===
 +
Notes, warnings, tips, and important templates can be used for informational messages that need to be offset from the regular text flow:
  
Now we will add a new brick to our distributed filesystem. We will run a rebalance (optional) to get the files distributed ideally. This will involve distributing some existing files on to our new brick on rhs-lab3:
+
<pre>{{note|this is a note}}</pre>
 +
{{note|this is a note}}
  
<console>
+
<pre>{{important|this is important}}</pre>
# ##i##gluster volume add-brick dist rhs-lab3:/data/dist
+
{{important|this is important}}
Add Brick successful
+
# ##i##gluster volume rebalance dist start
+
Starting rebalance on volume dist has been successful
+
</console>
+
  
After the rebalance, our distributed GlusterFS filesystem will have optimal performance and one third of the files will have moved to rhs-lab3.
+
<pre>{{warning|this is a warning}}</pre>
 +
{{warning|this is a warning}}
  
<console>
+
<pre>{{tip|this is a tip}}</pre>
# ##i##gluster volume rebalance dist status
+
{{tip|this is a tip}}
                                    Node Rebalanced-files          size      scanned      failures        status
+
                              ---------      -----------  -----------  -----------  -----------  ------------
+
                              localhost                0            0            0            0      completed
+
                                rhs-lab4                0            0            0            0      completed
+
                                rhs-lab3                0            0            0            0      completed
+
                                rhs-lab2                0            0            0            0      completed
+
  
</console>
+
Note that these templates used to be called <code>fancynote</code>, <code>fancytip</code>, etc. The "fancy" names have been deprecated but will still be supported for the forseeable future.
  
== Growing a GlusterFS Replicated Volume ==
+
=== Kernelop ===
 +
To display kernel configuration options, we encourage you to use the <tt>kernelop</tt> template. To use the <tt>kernelop</tt> template, create an entry similar to the following example:
 +
<pre>
 +
{{kernelop|title=foo,bar|desc=
 +
kernel options pasted from "make menuconfig"
 +
}}
 +
</pre>
  
You can grow a replicated volume by adding pairs of bricks:
+
{{note|Kernelop is colored blue to slightly resemble the blueish background from <tt>make menuconfig</tt>.}}
  
<console>
+
Adding this entry will give you the following output:  
# ##i##gluster volume add-brick mirror rhs-lab3:/data/mirror rhs-lab4:/data/mirror
+
{{kernelop|title=foo,bar|desc=
Add Brick successful
+
kernel options
# ##i##gluster volume info mirror
+
}}
+
Volume Name: mirror
+
Type: Distributed-Replicate
+
Volume ID: 4edacef8-982c-46a9-be7e-29e34fa40f95
+
Status: Started
+
Number of Bricks: 2 x 2 = 4
+
Transport-type: tcp
+
Bricks:
+
Brick1: rhs-lab1:/data/mirror
+
Brick2: rhs-lab2:/data/mirror
+
Brick3: rhs-lab3:/data/mirror
+
Brick4: rhs-lab4:/data/mirror
+
</console>
+
  
== GlusterFS Brick Migration ==
+
Here's a more concrete example:
 +
{{kernelop|title=File systems|desc=
 +
<M> Second extended fs support         
 +
[ ]  Ext2 extended attributes         
 +
[ ]  Ext2 execute in place support   
 +
<M> Ext3 journalling file system support
 +
}}
  
Here is how you migrate data off of an existing brick and on to a new brick:
+
Examples of usage:  
 +
* [[Package:AMD Catalyst Video Drivers]]
 +
* [[Package:ACPI Daemon]]
 +
* [[Microcode]]
  
<console>
+
=== Discussion Pages ===
# ##i##gluster volume replace-brick dist rhs-lab3:/data/dist rhs-lab4:/data/dist start
+
replace-brick started successfully
+
# ##i##gluster volume replace-brick dist rhs-lab3:/data/dist rhs-lab4:/data/dist status
+
Number of files migrated = 0        Migration complete
+
# ##i##gluster volume replace-brick dist rhs-lab3:/data/dist rhs-lab4:/data/dist commit
+
replace-brick commit successful
+
# ##i##gluster volume info
+
+
Volume Name: dist
+
Type: Distribute
+
Volume ID: f9758871-20dc-4728-9576-a5bb5b24ca4f
+
Status: Started
+
Number of Bricks: 3
+
Transport-type: tcp
+
Bricks:
+
Brick1: rhs-lab1:/data/dist
+
Brick2: rhs-lab2:/data/dist
+
Brick3: rhs-lab4:/data/dist
+
+
Volume Name: mirror
+
Type: Distributed-Replicate
+
Volume ID: 4edacef8-982c-46a9-be7e-29e34fa40f95
+
Status: Started
+
Number of Bricks: 2 x 2 = 4
+
Transport-type: tcp
+
Bricks:
+
Brick1: rhs-lab1:/data/mirror
+
Brick2: rhs-lab2:/data/mirror
+
Brick3: rhs-lab3:/data/mirror
+
Brick4: rhs-lab4:/data/mirror
+
</console>
+
  
== Removing a Brick ==
+
In MediaWiki, every "regular" wiki page has a corresponding "Talk" or "Discussion" page which has a page name prefixed by "Talk:" -- you can get to this page by going to the "Action" menu, and then choosing the "Discussion" menu item. These talk pages are typically used to discuss the edits that are going on in the "main" wiki page. The problem with talk pages is that they are kind of a pain to use. However, we have a way to fix that. If you want to enable a DISQUS-based mini-forum on a talk page, insert the following wikitext on the Talk page:
  
Here's how you remove a brick. The add-brick and remove-brick commands will ensure that you don't break mirrors, so you will need to remove both volumes in a mirror if you are working with a replicated volume.
+
<pre>
 +
{{DISQUS}}
 +
</pre>
  
<console>
+
...and presto! You will now have DISQUS-powered mini-forums to discuss whatever you want about your wiki page.
# ##i##gluster volume remove-brick dist rhs-lab4:/data/dist start
+
Remove Brick start successful
+
# ##i##gluster volume remove-brick dist rhs-lab4:/data/dist status
+
                                    Node Rebalanced-files          size      scanned      failures        status
+
                              ---------      -----------  -----------  -----------  -----------  ------------
+
                              localhost                0            0            0            0    not started
+
                                rhs-lab3                0            0            0            0    not started
+
                                rhs-lab2                0            0            0            0    not started
+
                                rhs-lab4                0            0            0            0      completed
+
  
# ##i##gluster volume remove-brick dist rhs-lab4:/data/dist commit
+
== Marking Pages as Needing Updates ==
Removing brick(s) can result in data loss. Do you want to Continue? (y/n) y
+
Remove Brick commit successful
+
  
</console>
+
If you find outdated wiki content, but you don't have the time or ability to update it, add one of the following templates to the wikitext of the page. This will add the page to the [[:Category:Needs Updates|Needs Updates Category]] so we can identify pages that need updating:
  
== Georeplication ==
+
<pre>
 +
{{PageNeedsUpdates}}
 +
{{SectionNeedsUpdates}}
 +
</pre>
  
At the local GlusterFS site:
 
  
<console>
+
Examples of usage:
# gluster volume create georep rhs-lab1:/data/georep
+
* [[UEFI Install Guide]]
Creation of volume georep has been successful. Please start the volume to access data.
+
* [[Package:MediaWiki]]
# gluster volume start georep
+
* [[Clang]]
Starting volume georep has been successful
+
# gluster volume info georep
+
+
Volume Name: georep
+
Type: Distribute
+
Volume ID: 001bc914-74ad-48e6-846a-1767a5b2cb58
+
Status: Started
+
Number of Bricks: 1
+
Transport-type: tcp
+
Bricks:
+
Brick1: rhs-lab1:/data/georep
+
# mkdir /mnt/georep
+
# mount -t glusterfs rhs-lab1:/georep /mnt/georep
+
# cd /mnt/georep/
+
# ls
+
# df -h .
+
Filesystem            Size  Used Avail Use% Mounted on
+
rhs-lab1:/georep      5.1G  33M  5.0G  1% /mnt/georep
+
</console>
+
  
At the remote site, set up a <tt>georep-dr</tt> volume:
+
=== Inline Code ===
  
<console>
+
To emphasize commands, and other technical jargon when they appear inline in a paragraph, use the <nowiki>{{c}}</nowiki> template. When referencing files, use the <nowiki>{{f}}</nowiki> template.
# ##i##gluster volume create georep-dr rhs-lab4:/data/georep-dr
+
# ##i##gluster volume start georep-dr
+
</console>
+
  
Local side:
+
<pre>
 +
The {{f|/etc/fstab}} file is an important one. Another important file is {{f|/boot/grub/grub.cfg}}. The {{c|emerge}} command is really nifty.
 +
</pre>
  
<console>
+
This example produces the following output:
# ##i##gluster volume geo-replication georep status
+
MASTER              SLAVE                                              STATUS   
+
--------------------------------------------------------------------------------
+
# ##i##gluster volume geo-replication georep ssh://rhs-lab4::georep-dr start
+
Starting geo-replication session between georep & ssh://rhs-lab4::georep-dr has been successful
+
</console>
+
  
== GlusterFS Security ==
+
The {{f|/etc/fstab}} file is an important one. Another important file is {{f|/boot/grub/grub.cfg}}. The {{c|emerge}} command is really nifty.
  
Currently, any GlusterFS peer can join your volume if it exists on your LAN. Securing GlusterFS can be accomplished with <tt>iptables</tt> by blocking TCP ports.
+
{{important|1=
 +
The &#60;tt&#62; tag has been deprecated for the purpose of tagging inline code, to conform with HTML5, and the previous use of the &#60;code&#62; tag is discouraged. It is more maintainable to use the <nowiki>{{c}}</nowiki> template. }}
  
[[Category:Filesystems]]
+
=== Slideshow ===
[[Category:Articles]]
+
 
{{PageNeedsUpdates}}
+
Any page has the capability of displaying a slideshow. Adding a slideshow to a page involves three steps:
{{ArticleFooter}}
+
 
 +
# Upload Images
 +
# Define Slides
 +
# Add Slideshow to page
 +
 
 +
==== Upload Images ====
 +
 
 +
To upload images, head to [[Special:Upload]] and upload a file. It is highly recommended to upload JPEG format images in high resolution -- MediaWiki will handle scaling JPEG automatically, saving bandwidth, but does not do this for PNG. Make sure that all images you upload have the same dimensions. When you upload, make note of the '''Destination Filename''' field -- this is the name that the upload will use when you reference it in your slide. It is recommended that you choose a simple descriptive name ending in ".jpg" for the '''Destination Filename'''.
 +
 
 +
==== Define Slides ====
 +
 
 +
Once images have been uploaded, you must define slides. To define slides on a page, you enter special semantic information about the slide on the page that it will be displayed, in the following format:
 +
 
 +
<pre><nowiki>
 +
{{#subobject:|slideIndex=0|slideCaption=
 +
== Wikitext Here ==
 +
This is a fantastic slide!
 +
|slideImage=File:Fruit.jpg|slideLink=PageName}}
 +
</nowiki></pre>
 +
 
 +
Here are some important instructions regarding defining slides:
 +
 
 +
* <code>slideIndex</code> must be 0 for the first slide, 1 for the second slide, etc. Numbers must be unique and incrementing from zero, and not doing this will result in slideshow display errors (but can be easily fixed by correcting the wikitext.)
 +
* <code>slideCaption=</code> can contain wikitext, such as headings and links. The best way to enter <code>slideCaption</code> is as above -- type a literal <code>slideCaption=</code>, followed by enter, then specify your wikitext, and terminate the caption by a single pipe character on the following line. Pipe characters are used to separate arguments from each other.
 +
* Specify your image name in the <code>slideImage</code> field. Your slideImage will have a name of <code>File:myname.jpg</code>, where <code>myname.jpg</code> is the '''Destination Filename''' you used when uploading the image.
 +
* An optional parameter called <code>slideLink=</code> can be provided to allow the image to be clickable and link to another wiki page. If it is omitted, then the image will not be clickable.
 +
 
 +
==== Add Slideshow to Page ====
 +
 
 +
Once the slides have been added to the page, you can add the following text to your page at the point you'd like the slideshow to appear:
 +
<pre>
 +
{{Slideshow}}
 +
</pre>
 +
 
 +
=== YouTube Videos (Screencasts, etc.) ===
 +
 
 +
Screencasting is an easy method to explain complex tasks. Take for instance <code>youtu.be/5KDei5mBfSg</code> and chop off the id and insert it into the following syntax to produce a video example.
 +
 
 +
<pre>{{#widget:YouTube16x9|id=5KDei5mBfSg}}</pre>
 +
{{#widget:YouTube16x9|id=5KDei5mBfSg}}
 +
 
 +
{{tip|The sample video above explains how to create your own screencasts under Funtoo Linux.}}
 +
 
 +
Most YouTube videos are in 16x9 format and should use the <code>YouTube16x9</code> widget. There is also a <code>YouTube4x3</code> widget for videos with a 4x3 aspect ratio.
 +
{{note|These YouTube widgets have been updated to be mobile-friendly.}}
 +
 
 +
[[Category:Wiki Development]]

Revision as of 07:38, January 4, 2015

Thanks for your interest in contributing to the the Funtoo wiki!

Types of Edits

Before we get started, let's review what changes are okay to make, and what changes are not okay:

Type of ChangeOkay?
Grammar/spelling fixesYes
New wiki contentYes
New package informationYes
Adding to existing articleMaybe -- see below
Adding missing/incomplete informationYes
Making correctionsYes
Adding work-arounds to problems experiencedNo - open bug first on bug tracker.
Important

Note that if you experience some problem with Funtoo Linux, during installation or otherwise, the proper course of action is to not add a work-around to our documentation, but to open a bug on our bug tracker. This is important because the problem you experienced may be a legitimate bug and the solution may be to fix the bug rather than add a work-around to our documentation. We may end up fixing a bug, making a documentation fix, or possibly both.

Basics

Here is a list of basic wiki information that you will need to know to get started:

  • First, to perform edits on the wiki, you must Create a Funtoo account and log in.
  • You can create a new page by navigating to http://www.funtoo.org/New_Page_Name. Underscores are the equivalent of spaces. Then select "Create" under the "Actions" menu.
  • Whether creating a new page or editing an existing page by clicking "Edit", you will be presented with Web-based text editor that allows you to modify the wikitext of the page. The wikitext is rendered to produce the document you see when you view the page normally.
  • Another fun thing you can do is click on your name under the "Account" menu once you have logged in. This will bring you to your "User" page. Then click "Create with Form" unde the "Actions" menu and enter your geographic and other information. This will allow you to be displayed on our Usermap and will also allow your full name to be displayed on Ebuild pages for which you are an author. It's generally a good idea to do this.
Tip

The following sections document how to use wikitext and Funtoo templates on the Funtoo wiki.

Paragraphs

To create a new paragraph, insert a blank line between two lines of text. If a blank line doesn't exist between two lines of wikitext, they will be combined into a single flowing paragraph.

If you leave leading whitespace at the beginning of a line, MediaWiki will render it as pre-formatted text. Beware of this. Here's an example:

foobar

This can rear its ugly head when specifying template parameters, so you will get this:

Note
ugh!

...instead of this:

Note

This looks much better!

Page and Section Capitalization

In general, capitalize all words in page names and section heading except:

  • Articles: a, an, the
  • Coordinating Conjunctions: and, but, or, for, nor, etc.
  • Prepositions (fewer than five letters): on, at, to, from, by, etc.

Document Hierarchy

Use section headings to create a document hierarchy for your page. These will define the table of contents that appears at the top of the wiki page. Create chapters, sections and sub-sections as follows:

= Page Title =

== Chapter Title ==

=== Section Title ===

==== SubSection Title ====

Note

By default, Table of Contents is disabled on the Funtoo wiki. If you would like to enable the TOC, you can place a __TOC__ on a blank line where you'd like the Table of Contents to appear, or place __FORCETOC__ on a blank line anywhere in the wikitext to force the TOC to appear at the top of the page.

In general, when creating new documents, it's best to use level-3 (three "="'s) Section Titles to break up content. Level-2 Section Titles are best used for major sections of larger documents. Use them infrequently. Level-1 Section Titles generally do not need to be used.

Links

Internal links to other wiki pages can be specified as [[pagename]]. To specify an alternate name for the link, use [[pagename|my link name]].

For external links, use [http://funtoo.org my link] to specify a URL. If you want the URL to appear in the wikitext, you can specify it without brackets: http://forums.funtoo.org.

Lists

MediaWiki supports a number of list formats:

  • Unordered List
  • Unordered Item 2
    • Unordered sub-item
  1. Ordered List
  2. Ordered Item 2
    1. Ordered sub-item
Term
This is called a "definition list". It is used when defining various terms.

If you need to quote a portion of text from another site, use <blockquote> as follows:

Wikipedia (ˌwɪkɨˈpiːdiə/ or wɪkiˈpiːdiə/ wik-i-pee-dee-ə) is a collaboratively edited, multilingual, free-access, free content Internet encyclopedia that is supported and hosted by the non-profit Wikimedia Foundation. Volunteers worldwide collaboratively write Wikipedia's 30 million articles in 287 languages, including over 4.5 million in the English Wikipedia. Anyone who can access the site can edit almost any of its articles, which on the Internet comprise[4] the largest and most popular general reference work.[5][6][7][8][9] In February 2014, The New York Times reported that Wikipedia is ranked fifth globally among all websites stating, "With 18 billion page views and nearly 500 million unique visitors a month..., Wikipedia trails just Yahoo, Facebook, Microsoft and Google, the largest with 1.2 billion unique visitors."[10]

Literal Text and HTML Symbols

Here is wikitext for the section above, which I am displaying by placing the literal wikitext between a <pre> and </pre> tag. If you want to disable wikitext processing for an inline span of text, use <nowiki> and </nowiki>. If you want to print out a tag literally, use &#60; and &#62; (In the wikitext, I used &amp;#60; and &amp;#62 to display these!)

* Unordered List
* Unordered Item 2
** Unordered sub-item

# Ordered List
# Ordered Item 2
## Ordered sub-item

;Term: This is called a "definition list". It is used when defining various terms.

If you need to quote a portion of text from another site, use <tt><blockquote></tt> as follows:

<blockquote>
Wikipedia (ˌwɪkɨˈpiːdiə/ or wɪkiˈpiːdiə/ wik-i-pee-dee-ə) is a collaboratively edited, multilingual, free-access, 
free content Internet encyclopedia that is supported and hosted by the non-profit Wikimedia Foundation. Volunteers
worldwide collaboratively write Wikipedia's 30 million articles in 287 languages, including over 4.5 million in the 
English Wikipedia. Anyone who can access the site can edit almost any of its articles, which on the Internet 
comprise[4] the largest and most popular general reference work.[5][6][7][8][9] In February 2014, The New York 
Times reported that Wikipedia is ranked fifth globally among all websites stating, "With 18 billion page views 
and nearly 500 million unique visitors a month..., Wikipedia trails just Yahoo, Facebook, Microsoft and Google, 
the largest with 1.2 billion unique visitors."[10]
</blockquote>

Linking to Packages

To link to a package page, use the Package template:

{{Package|sys-apps/portage}}

This template will create a link to the official wiki page for sys-apps/portage, and render using the official "English" page name, as follows:

Package:Portage (Funtoo)

If you specify a yet-to-be-documented ebuild, it will render like this (which is okay -- it will encourage people to document it):

sys-foo/undocumented-ebuild (package not on wiki - please add)

Tables

Instead of using traditional MediaWiki table wikitext, use the following format:

{{TableStart}}
<tr class="info"><th>Header 1</th><th>Header 2</th></tr>
<tr><td>Value 1</td><td>Value 2</td></tr>
<tr><td>Value 3</td><td>Value 4</td></tr>
{{TableEnd}}

This wil render as follows:

Header 1Header 2
Value 1Value 2
Value 3Value 4
Tip

This table syntax has an added benefit of creating a responsive table that renders properly on mobile devices.

It is possible to use the following CSS classes with tr (rows) and td/th elements to color them as desired:

Class Name
success
info
warning
active
danger

Displaying Source Code

To display source code, use can use the file template, specifying a lang= parameter:

{{file|name=foobar|lang=python|desc=foobarosity|body=
import system
}}

This will produce:

foobar (python source code) - foobarosity
import system

The parameters name (filename), lang (language for syntax highlighting) and desc (Description, appearing as a caption) are optional. For a list of supported languages, see this list.


Important

If you need to display the pipe ("|") character within the body of a file template, replace each "|" with {{!}} -- otherwise your file contents will not display properly. This is necessary because {{file}} is a template and the "|" character is used as a delimiter for arguments to the template.

Displaying Text File Contents

For displaying the contents of non-programming language text files (like config files), you have two options. You can enclose your lines within <pre> tags, or use the new file template. The file template is used like so:

{{file|name=/etc/foo.conf|desc=My foo.conf file|body=
# /etc/host.conf:
# $Header: /var/cvsroot/gentoo/src/patchsets/glibc/extra/etc/host.conf,v 1.1 2006/09/29
}}

This will produce:

/etc/foo.conf - My foo.conf file
# /etc/host.conf:
# $Header: /var/cvsroot/gentoo/src/patchsets/glibc/extra/etc/host.conf,v 1.1 2006/09/29

Console

To display console output, use the <console> tag:

For a root console:

<console>
###i## run a command as root
</console>

Produces:

# run a command as root

For a non-root console:

<console>
$ ##i##run a command as user
</console>

Produces:

$ run a command as user
Important

Note that we use a # prompt for root and a $ prompt to denote a non-root user.

Important

The ##i## text tags the rest of the line as being user input ("i" is for "input"). It is then highlighted in a noticeable color so it stands out from text that is not typed in by the user.

If you need to end highlighting of user input prior to the end of a line, use ##!i## to mark the end of the highlighted area.

The following special character sequences are also available:

  • ##g## - Green
  • ##y## - Yellow
  • ##bl## - Blue
  • ##r## - Red
  • ##b## - Bold

Please use the above coloring options sparingly. It is sometimes nice to use them to get wiki console output to match the colors that are displayed on a Linux console. Also note that for every color above, there is a matching ##!(colorcode)## option to turn color off prior to end of line.

Here is an example of its use:
# bluetoothctl 
[NEW] Controller 00:02:72:C9:62:65 antec [default]
[bluetooth]#power on
Changing power on succeeded
[bluetooth]# agent on
Agent registered
[bluetooth]# scan on
Discovery started
[bluetooth]# devices
Device 00:1F:20:3D:1E:75 Logitech K760
[bluetooth]# pair 00:1F:20:3D:1E:75
Attempting to pair with 00:1F:20:3D:1E:75
[CHG] Device 00:1F:20:3D:1E:75 Connected: yes
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[CHG] Device 00:1F:20:3D:1E:75 Paired: yes
Pairing successful
[CHG] Device 00:1F:20:3D:1E:75 Connected: no
[bluetooth]# connect 00:1F:20:3D:1E:75
Attempting to connect to 00:1F:20:3D:1E:75
[CHG] Device 00:1F:20:3D:1E:75 Connected: yes
Connection successful
[bluetooth]# quit
[DEL] Controller 00:02:72:C9:62:65 antec [default]
#

Informational Messages

Notes, warnings, tips, and important templates can be used for informational messages that need to be offset from the regular text flow:

{{note|this is a note}}
Note

this is a note

{{important|this is important}}
Important

this is important

{{warning|this is a warning}}
Warning

this is a warning

{{tip|this is a tip}}
Tip

this is a tip

Note that these templates used to be called fancynote, fancytip, etc. The "fancy" names have been deprecated but will still be supported for the forseeable future.

Kernelop

To display kernel configuration options, we encourage you to use the kernelop template. To use the kernelop template, create an entry similar to the following example:

{{kernelop|title=foo,bar|desc=
kernel options pasted from "make menuconfig"
}} 
Note

Kernelop is colored blue to slightly resemble the blueish background from make menuconfig.

Adding this entry will give you the following output: Under foo-->bar:

kernel options

Here's a more concrete example: Under File systems:

<M> Second extended fs support          
[ ]   Ext2 extended attributes          
[ ]   Ext2 execute in place support     
<M> Ext3 journalling file system support

Examples of usage:

Discussion Pages

In MediaWiki, every "regular" wiki page has a corresponding "Talk" or "Discussion" page which has a page name prefixed by "Talk:" -- you can get to this page by going to the "Action" menu, and then choosing the "Discussion" menu item. These talk pages are typically used to discuss the edits that are going on in the "main" wiki page. The problem with talk pages is that they are kind of a pain to use. However, we have a way to fix that. If you want to enable a DISQUS-based mini-forum on a talk page, insert the following wikitext on the Talk page:

{{DISQUS}}

...and presto! You will now have DISQUS-powered mini-forums to discuss whatever you want about your wiki page.

Marking Pages as Needing Updates

If you find outdated wiki content, but you don't have the time or ability to update it, add one of the following templates to the wikitext of the page. This will add the page to the Needs Updates Category so we can identify pages that need updating:

{{PageNeedsUpdates}}
{{SectionNeedsUpdates}}


Examples of usage:

Inline Code

To emphasize commands, and other technical jargon when they appear inline in a paragraph, use the {{c}} template. When referencing files, use the {{f}} template.

The {{f|/etc/fstab}} file is an important one. Another important file is {{f|/boot/grub/grub.cfg}}. The {{c|emerge}} command is really nifty.

This example produces the following output:

The /etc/fstab file is an important one. Another important file is /boot/grub/grub.cfg. The emerge command is really nifty.

Important

The <tt> tag has been deprecated for the purpose of tagging inline code, to conform with HTML5, and the previous use of the <code> tag is discouraged. It is more maintainable to use the {{c}} template.

Slideshow

Any page has the capability of displaying a slideshow. Adding a slideshow to a page involves three steps:

  1. Upload Images
  2. Define Slides
  3. Add Slideshow to page

Upload Images

To upload images, head to Special:Upload and upload a file. It is highly recommended to upload JPEG format images in high resolution -- MediaWiki will handle scaling JPEG automatically, saving bandwidth, but does not do this for PNG. Make sure that all images you upload have the same dimensions. When you upload, make note of the Destination Filename field -- this is the name that the upload will use when you reference it in your slide. It is recommended that you choose a simple descriptive name ending in ".jpg" for the Destination Filename.

Define Slides

Once images have been uploaded, you must define slides. To define slides on a page, you enter special semantic information about the slide on the page that it will be displayed, in the following format:

{{#subobject:|slideIndex=0|slideCaption=
== Wikitext Here ==
This is a fantastic slide!
|slideImage=File:Fruit.jpg|slideLink=PageName}}

Here are some important instructions regarding defining slides:

  • slideIndex must be 0 for the first slide, 1 for the second slide, etc. Numbers must be unique and incrementing from zero, and not doing this will result in slideshow display errors (but can be easily fixed by correcting the wikitext.)
  • slideCaption= can contain wikitext, such as headings and links. The best way to enter slideCaption is as above -- type a literal slideCaption=, followed by enter, then specify your wikitext, and terminate the caption by a single pipe character on the following line. Pipe characters are used to separate arguments from each other.
  • Specify your image name in the slideImage field. Your slideImage will have a name of File:myname.jpg, where myname.jpg is the Destination Filename you used when uploading the image.
  • An optional parameter called slideLink= can be provided to allow the image to be clickable and link to another wiki page. If it is omitted, then the image will not be clickable.

Add Slideshow to Page

Once the slides have been added to the page, you can add the following text to your page at the point you'd like the slideshow to appear:

{{Slideshow}}

YouTube Videos (Screencasts, etc.)

Screencasting is an easy method to explain complex tasks. Take for instance youtu.be/5KDei5mBfSg and chop off the id and insert it into the following syntax to produce a video example.

{{#widget:YouTube16x9|id=5KDei5mBfSg}}

Tip

The sample video above explains how to create your own screencasts under Funtoo Linux.

Most YouTube videos are in 16x9 format and should use the YouTube16x9 widget. There is also a YouTube4x3 widget for videos with a 4x3 aspect ratio.

Note

These YouTube widgets have been updated to be mobile-friendly.