The theforeman.org from theforeman

Foreman 1.5 manual

Being worked on in _includes/manuals/1.5/.

Tasks:

#4197 moved ~foreman/config/settings.plugins.d/ to /etc/foreman/plugins/ which will break some RPM upgrades (dir changing to symlink), so users should backup and restore plugin configs before/after upgrades
oVirt image support (set "Image ID" to the UUID of the image, finish template etc)
Installer plugin and compute resource support (#3308)
Inherited orgs/locs (#3912)
Avatar/LDAP info (#3827)
Upgrade notes on the new auth system (#812)
libvirt image support (#4123)
Hammer config file location change (#4792)
Taxonomy from Puppet run settings (#3214)
oVirt upgrade notes on SSL verification (#4555)
new fact upload settings on node.rb (parallel, watch)
update installer options (closer to final)
Link all issue numbers
Contributors list
Config groups

Release note videos modals aren't showing up

Visit http://theforeman.org/manuals/1.8/index.html#Releasenotesfor1.8 and click one of the YouTube video icons on the right hand side. This should open up a modal with the video embedded, but instead the page greys out and no video is displayed.

Inherited orgs/locations

A description of how inherited organisations/locations work should be added - in fact, we're missing multi-org entirely from the manual. In particular how the views and permitted assignments work.

Host creation inherit from host group feature

The host group inheritance features (#9591) during host creation added in Foreman 1.10 should be described in the manual, probably around section 4.4 (Provisioning). It should explain how attributes are copied from a group on host creation and that they can be inherited, changed explicitly or unset explicitly.

API documentation needs refreshing

The API docs are currently out of date, they're built on 1.6 or thereabouts I think.

1.4 Manual references to Foreman 1.3.x

The documentation for the API refers to Foreman 1.3.

License.md missing

Apart of the contribution.md, there is no mention of any license.
Is it implied that the theforeman.org is also part of the project and should be treated as GPL too ?
Would it be possible to have a license.md with the relevant license in it ?

Invalid url for plugins

_includes/manuals/1.8/1.2_release_notes.md line 69 has references to plugins, Chef, Salt, and the index. These links do not seem to be working.

README linebreaks

The section "Updating API Auto-Generated Docs by apipie" does not show link breaks. I thought markdown automatically does this.

Fix consistency between the pagination buttons and the return/search buttons on the blog

It should just be a question of adding btn btn-foreman-blue to the pagination class, but something is interfering with the background.

Documentation has wrong order for installation from source

When trying to install from source as described in http://theforeman.org/manuals/1.2/index.html#3.4InstallFromSource the bundle install fails with:

# bundle install --without mysql mysql2 postgresql test --path vendor
Unfortunately, a fatal error has occurred. Please see the Bundler troubleshooting documentation at http://bit.ly/bundler-issues.
Thanks!
/opt/foreman/.rvm/rubies/ruby-1.9.3-p448/lib/ruby/1.9.1/psych.rb:297:in `initialize': No such file or directory - /opt/foreman/foreman-1.2.2/config/settings.yaml (Errno::ENOENT)
        from /opt/foreman/.rvm/rubies/ruby-1.9.3-p448/lib/ruby/1.9.1/psych.rb:297:in `open'
        from /opt/foreman/.rvm/rubies/ruby-1.9.3-p448/lib/ruby/1.9.1/psych.rb:297:in `load_file'
        from /opt/foreman/foreman-1.2.2/config/settings.rb:3:in `<top (required)>'
        from /opt/foreman/.rvm/rubies/ruby-1.9.3-p448/lib/ruby/site_ruby/1.9.1/rubygems/core_ext/kernel_require.rb:53:in `require'
        from /opt/foreman/.rvm/rubies/ruby-1.9.3-p448/lib/ruby/site_ruby/1.9.1/rubygems/core_ext/kernel_require.rb:53:in `require'
        from /opt/foreman/foreman-1.2.2/Gemfile:1:in `eval_gemfile'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/lib/bundler/dsl.rb:30:in `instance_eval'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/lib/bundler/dsl.rb:30:in `eval_gemfile'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/lib/bundler/dsl.rb:9:in `evaluate'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/lib/bundler/definition.rb:19:in `build'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/lib/bundler.rb:148:in `definition'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/lib/bundler/cli.rb:245:in `install'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/lib/bundler/vendor/thor/task.rb:27:in `run'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/lib/bundler/vendor/thor/invocation.rb:120:in `invoke_task'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/lib/bundler/vendor/thor.rb:344:in `dispatch'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/lib/bundler/vendor/thor/base.rb:434:in `start'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/bin/bundle:20:in `block in <top (required)>'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/lib/bundler/friendly_errors.rb:3:in `with_friendly_errors'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/gems/bundler-1.3.5/bin/bundle:20:in `<top (required)>'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/bin/bundle:23:in `load'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448@global/bin/bundle:23:in `<main>'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448/bin/ruby_executable_hooks:15:in `eval'
        from /opt/foreman/.rvm/gems/ruby-1.9.3-p448/bin/ruby_executable_hooks:15:in `<main>'

It seems to be necessary to copy the configuration files before doing the install.

Also the example makes no sense since it states the bundle install should be run like this:

bundle install --without mysql mysql2  sqlite test --path vendor

but the stated config/database.yml.example uses a sqlite database. Therefore a hint would be nice either to change the db config or providing the correct set that should not be used.

Move smart_proxy_chef documentation

Section 4.3.4 documented the built-in Chef support in Smart Proxy 1.6 and earlier, but it was moved to smart_proxy_chef in 1.7.

This section should be moved to plugin-specific documentation (like Discovery).

FreeBSD provisioning

Perhaps part of section 4.4 (provisioning), but some detail around FreeBSD provisioning and its requirements (#2572) would be good.

Display latest versions

The website used to have the latest version displayed clearly on the home page, but this was lost during #274.

The partial is still there at _includes/social.html and I'm regularly updating it, it just needs fitting into the new design somewhere. Perhaps under the two buttons on the homepage?

Jekyll 3 compatibility

As jekyll 3 is approaching (see github/pages-gem#175) we should care about it. With the following diff, the site is building again, but there are some glitches, so this is just to raise awareness for now.

diff --git a/_config.yml b/_config.yml
index cda5e03..f296337 100644
--- a/_config.yml
+++ b/_config.yml
@@ -18,7 +18,7 @@ blogdesc: News, notes and noise from around the Foreman community
 safe:        false

 future:      false
-highlighter: pygments
+highlighter: rouge
 markdown:    rdiscount

 navigation:
@@ -35,3 +35,5 @@ navigation:

 gems:
   - jekyll-feed
+  - jekyll-gist
+  - jekyll-paginate

Add "edit this" links to the manual

The manuals should have edit icons next to each section to invite readers to submit fixes back to this repository via a PR.

Foreman 1.9 manual

Usual stuff:

Headline features
Itemised release notes (@domcleal)
- http://projects.theforeman.org/projects/foreman/issues?utf8=%E2%9C%93&set_filter=1&f%5B%5D=status_id&op%5Bstatus_id%5D=c&f%5B%5D=release_id&op%5Brelease_id%5D=%3D&v%5Brelease_id%5D%5B%5D=35&f%5B%5D=&c%5B%5D=project&c%5B%5D=tracker&c%5B%5D=subject&c%5B%5D=category&c%5B%5D=closed_on&group_by=
Foreman setting changes
Smart proxy setting changes
Installer options refresh
Contributors list (@domcleal)
Translator contributors (@domcleal)
Installer module release notes

1.9 specifics:

BMC: rubyipmi 0.10.0 changed the default IPMI driver to "lan20" which may stop it working on older hardware models
#10167 - API unversioned default changed from v1 to v2
#8566 - settings categories reorganised
Remove Chef smart proxy config chapter (renumbering, will affect realms doc link in Foreman)
Remove umask warning in foreman-installer docs
Logging configuration (http://projects.theforeman.org/projects/foreman/wiki/Troubleshooting#How-do-I-enable-debugging)
#10703 - console port now randomised, ensure full range is open in firewall rules
#10284 - support page now needs foreman-debug's -u option for 1.9
#1213, #1510 - add audit and build notification messages to email management chapter

foreman-installer smartproxy error (undefined method 'find')

I get the following error on Ubuntu Trusty

[ERROR 2014-06-04 08:09:59 verbose] /Stage[main]/Foreman_proxy::Register/Foreman_smartproxy[homesystem.rabbithole]: Could not evaluate: undefined method `find' for #String:0x000000051f5928

There are no other errors and the web dashboard seems to work fine. Clues?

Add ipv6 support / AAAA DNS record for "deb.theforeman.org"

Compute resources key pair workflow

The way some compute resources (Openstack, EC2...) create a key pair is currently very obscure for the user. The process should be documented, especially since it stores the secret key on the database and it's not retrievable in any way by any user other than people with access to the Foreman database.

Settings list in section 3.5.2 is out of date for 1.10

The settings list in section 3.5.2 is out of date as of Foreman 1.10 where new settings were added.

Settings also now have a friendly name which is displayed in the UI in preference to the underscored name used in the DB and settings.yaml.

Foreman 1.8 manual

Foreman 1.11 manual

Usual stuff:

1.11 specifics:

Smart-proxy templates feature not documented

http://theforeman.org/manuals/1.7/index.html#4.3SmartProxies should include a subsection about templates handling with an example configuration file and so forth. @dustints would you mind to do it since you wrote the feature?

Clean up html leftovers in old blogs

Some of the pandoc-converted blogs are a mess, we should clean them up a bit

Missing link to blog

Since the last redesign, the website is missing a link to blog.theforeman.org or /blog.html.

Manual Page: bs-docs-sidebar doesn't scroll with page

The bs-docs-sidebar doesn't scroll with the page. I suppose that's intentional, but on my Macbook Air this results in the scrollbar going off the screen and being unable to navigate to longer sections of the document:

Ostensibly, the "affix" attribute is supposed to fix this, but this didn't work when I tried it myself, but admittedly, my web design skills peaked around the time the blink tag was fashionable.

The first answer on this stackoverflow thread looks like the right direction:

http://stackoverflow.com/questions/4340143/sidebar-that-follows-scroll-but-scrolls-self-if-taller-than-viewport

API v2 error responses

The API v2 section (5.1) should document the format of error responses that the API will generate (the JSON objects with messages etc).

Missing SSL certs/keys for facts on multiple puppetmasters with no ENC

_includes/manuals/1.2/3.5.5_importing_facts.md

Refers to this script https://github.com/theforeman/puppet-foreman/blob/283619064fbde0275235535b19c53da249357035/files/push_facts.rb which was deleted.

The script needs to be updated to include the CA file and certs or the docs need to be updated to explain how to do it without the script.

$foreman_ssl_ca = "/var/lib/puppet/ssl/certs/ca.pem"
$foreman_ssl_cert = "/var/lib/puppet/ssl/certs/<fqdn>.pem" 
$foreman_ssl_key = "/var/lib/puppet/ssl/private_keys/<fqdn>.pem"

And at the http part

http.ca_file = $foreman_ssl_ca
http.cert = OpenSSL::X509::Certificate.new(File.read($foreman_ssl_cert))
http.key  = OpenSSL::PKey::RSA.new(File.read($foreman_ssl_key), nil)

Thanks,
William

Foreman manual 1.4 GCE notes

To avoid people making the same silly mistake enabling GCE as a compute resource can I suggest the documentation for 5.2.4 Google Compute Engine Notes be updated from
"Requires client e-mail address and p12 certificate file to access"
to
Requires client e-mail address of an authorised google cloud console client ID is entered in the new compute resource screen and the .p12 certificate file is stored on the foreman server in a location the foreman user account has permission to read

VMware user-data/customization template support

Foreman 1.8 supports using user-data templates in cloud-init style, which are interpreted by Fog into customization templates for VMware. This should be documented in 5.2.

http://projects.theforeman.org/issues/8601

Unfortunately it appears it may not work: https://groups.google.com/forum/#!topic/foreman-dev/Lsfw9CunyzA

CoreOS provisioning

Foreman 1.8 supports provisioning of CoreOS, which should be added to the website and manual.

http://projects.theforeman.org/issues/7652
https://github.com/theforeman/community-templates/tree/master/coreos

Blog and the Homepage

There should at least be a link to the blog on the foreman home page. It would be beter to have links to the X(=3?) latest articles as well.

Foreman passes incorrect case sensitivity on "Run Puppet" to mco

When using the "Run Puppet" button on hosts in Foreman, under the mco provider, it will send the command to mco with a lower case fqdn and will then fail to find it:

mco ping:
Ultralisk time=104.35 ms

Command as it comes in from foreman:
[root@puppet etc]# /usr/bin/mco puppet runonce -I ultralisk No request sent, we did not discover any nodes.

but if you manually run it with the correct case it works fine.

the site is down!

the site seems to be down

Link colour is unreadable

@abenari could we change the link colour to something like #34799d? I'm struggling to notice links in the manual since the redesign and am worried readers will miss them.

Foreman 1.4 manual

Tasks:

Error installing on Ubuntu Trusty using apt-get

The following packages have unmet dependencies:
ruby-kafo-parsers : Depends: ruby-rdoc (>= 3.12.0) but it is not going to be installed
E: Unmet dependencies. Try 'apt-get -f install' with no packages (or specify a solution).

I had to do dpkg --purge ruby-kafo-parsers ruby-kafo to be able to use apt again. Dependency hell?

SLES provisioning

Perhaps part of section 4.4 (provisioning), but some detail around SLES provisioning (#3733) would be good.

Global status and substatus descriptions

A new section, perhaps 4.9 Monitoring in 4. General Foreman should be added to describe the global statuses and substatuses feature added in Foreman 1.10.

It should show that each host has multiple statuses shown on its own host page, and this is combined into a global status shown on the host list. The APIs show this too, with individual statuses and a global status.

Smart proxy plugins

The smart proxy section (4.3) and probably the plugins section (6) should have information about smart proxy plugins, how they add extra config files, how to enable them etc and how they're packaged.

#8979: Hammer (only) requires SCL packages to be available

The upgrade section (3.6) for Foreman 1.10 and the RPM packages section (3.3.1) should state that EL installations with Hammer only now also require SCL packages to be available. Previously they only needed EPEL.

Foreman 1.6 manual

Work in progress:

Update Hammer success story examples

The Hammer "success story" in section 4.5.2 needs updating as some of the arguments have been improved, e.g. using names instead of IDs.

I'd also like to see improved formatting and explanations of the commands.

Foreman 1.10 manual

Usual stuff:

1.10 specifics:

Foreman 1.8.0 release info on site eats up too much page space.

Browsing the Foreman API is tough after the site redesign. The 1.8.0 announcement takes up too much screen space.

Browser: Chrome 42.0.2311.90

URL: http://www.theforeman.org/api_v2.html

Screenshots:

Signing key for Debian packages not available as a secure download

The manual (as of version 1.5.2) instructs you to start the installation on a Debian system by runnning the following commands:

echo "deb http://deb.theforeman.org/ wheezy 1.5" > /etc/apt/sources.list.d/foreman.list
echo "deb http://deb.theforeman.org/ plugins 1.5" >> /etc/apt/sources.list.d/foreman.list
wget -q http://deb.theforeman.org/pubkey.gpg -O- | apt-key add -
apt-get update && apt-get install foreman-installer

Notice how the signing key is downloaded through plain HTTP. Simply replacing http with https in the URL doesn't work: strangely I don't even get a server error, just no response at all. The key has to be available from a secure source to even be useful at all, otherwise you can be MITM-ed and never notice any errors or failures.

theforeman / theforeman.org Goto Github PK

theforeman.org's People

Contributors

Stargazers

Watchers

Forkers

theforeman.org's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs