Retrying to creating the starting docs (prev PR#162)
This commit is contained in:
parent
dc44933eb9
commit
288573160b
3 changed files with 237 additions and 0 deletions
|
@ -1,6 +1,8 @@
|
|||
* xref:overview.adoc[A global overview]
|
||||
* xref:day_to_day_fedora.adoc[Working with Fedora Infrastructure]
|
||||
* xref:join.adoc[Join the team]
|
||||
** xref:gettingstarted.adoc[Getting Started with Infrastructure]
|
||||
** xref:apprentice.adoc[Infrastructure Apprentice Progam]
|
||||
* xref:map_critical_services.adoc[Map of critical services]
|
||||
* xref:services.adoc[List of our services]
|
||||
** xref:services.adoc#_accounts[Account management]
|
||||
|
|
105
modules/ROOT/pages/apprentice.adoc
Normal file
105
modules/ROOT/pages/apprentice.adoc
Normal file
|
@ -0,0 +1,105 @@
|
|||
= Infrastructure Apprentice
|
||||
|
||||
The 'fi-apprentice' group in the Fedora Account System is one with a lot of read-only access to various
|
||||
Fedora infrastructure machines. This group is used for new folks to look around at the infrastructure setup,
|
||||
check machines and processes and see where they might like to contribute moving forward. This also allows
|
||||
apprentices to examine and gather info on problems, then propose solutions.
|
||||
|
||||
== Access to many infrastructure machines
|
||||
|
||||
Members of the fi-apprentice group have ssh/shell access to many machines, but no sudo rights or ability
|
||||
to commit to ansible (but they do have read-only access). Apprentice can, however, contribute to the
|
||||
infrastructure documentation by sending pull requests to the https://pagure.io/infra-docs-fpo[infra-docs-fpo]
|
||||
repository. Access is via the bastion.fedoraproject.org machine and from there to each machine. See the
|
||||
https://docs.fedoraproject.org/en-US/infra/sysadmin_guide/sshaccess/[SSH Access Infrastructure SOP] for more
|
||||
info. You can see a list of hosts that allow apprentice access by using:
|
||||
`./scripts/hosts_with_var_set -i inventory/ -o ipa_client_shell_groups=fi-apprentice`
|
||||
from an ansible repo checkout (see below).
|
||||
|
||||
== Nagios alerts
|
||||
|
||||
This group does NOT get Nagios alerts. If you would like to see them you can join the #fedora-noc channel, adjust your
|
||||
https://apps.fedoraproject.org/notifications[FMN notifications settings] or watch the Nagios web interface at:
|
||||
https://admin.fedoraproject.org/nagios/ and https://nagios-external.fedoraproject.org/nagios/
|
||||
|
||||
Nagios access is now controlled by kerberos, so you will need to do a command with “kinit your_fas_name@@FEDORAPROJECT.ORG”.
|
||||
On the use of the kerberos, you can view the page https://fedoraproject.org/wiki/Infrastructure/Kerberos
|
||||
|
||||
== Length of membership
|
||||
|
||||
Members who have not logged into any machine and/or are not active will be removed. There's nothing personal
|
||||
in this, and you're welcome to re-join later when you have more time, we just want to make sure the group only
|
||||
has active members.
|
||||
|
||||
== Longer term quests
|
||||
|
||||
There's a few items we need help with ongoing and apprentices are encouraged to work on these items and provide patches
|
||||
and ask questions, etc. The current list:
|
||||
|
||||
* Update group variables in ansible for CSI standards for machines that don't have any listed. See:
|
||||
https://docs.fedoraproject.org/en-US/Community_Services_Infrastructure/1/html/Security_Policy/index.html
|
||||
for information on CSI, and look at the ansible repo under inventory/group_vars/ for groups without CSI information.
|
||||
Patches adding this information for groups can be sent to the infrastructure list to be reviewed and applied. Please
|
||||
refer to https://fedoraproject.org/wiki/Standards_for_documenting_CSI_variables[standards for documenting CSI variables] before submitting patches
|
||||
for ansible.
|
||||
|
||||
* Our docs aren't all using the same template. See the https://pagure.io/infra-docs-fpo repo and propose patches
|
||||
to update documents to use the same templates as the rest.
|
||||
|
||||
* Look over our logs on log01.iad2.fedoraproject.org in /var/log/merged/ and track down issues and propose solutions to
|
||||
them. Be sure to discuss in meeting or in a issue whatever you find.
|
||||
|
||||
== easyfix tickets
|
||||
|
||||
There are tickets marked with the 'easyfix' keyword that may be suitable for apprentices to learn how things are setup, and also contribute a
|
||||
fix. See the https://pagure.io/fedora-infrastructure/issues?status=Open&tags=easyfix[pagure.io easyfix report]
|
||||
|
||||
=== Working on a ticket workflow
|
||||
|
||||
* Pick a ticket
|
||||
|
||||
Look in https://pagure.io/fedora-infrastructure/issues for a ticket that looks interesting to you. If the ticket is already assigned, but hasn't
|
||||
had any action in a while, feel free to ask on the ticket if it's still being worked on, and if there is no reply in a week or so, take it over.
|
||||
Some tickets can be worked on by several people, so feel free to ask in ticket if this is one of those kinds of tasks and what part you can work
|
||||
on. If a ticket seems really old and like it may no longer be needed, please add it to the agenda of the next meeting and we will discuss it
|
||||
there and close it or rework it as needed. You can add to the next meeting agenda in Gobby.
|
||||
|
||||
* Make patch for fix from git ansible repo
|
||||
|
||||
Most any task will require changes to ansible. You can check this out on batcave01.iad2.fedoraproject.org
|
||||
(just "git clone /git/ansible" there) and make edits to your local copy. Then you can create a PR with your changes into https://pagure.io/fedora-infra/ansible
|
||||
|
||||
== IRC Tips
|
||||
|
||||
One of the primary ways the infrastructure team communicates is via IRC. Here's a few tips to best communicate with the rest of the team:
|
||||
|
||||
* Feel free to ask questions when you think of them/run into them, but don't expect everyone to drop what they are doing and answer right then.
|
||||
Please be patient.
|
||||
|
||||
* Try to avoid private messages to specific team members. Instead ask your questions in #fedora-admin or #fedora-noc if at all possible. This
|
||||
allows anyone to help you out and also other folks to see the answer and peer review the answers you get.
|
||||
|
||||
* Try and assume best intentions on past decisions. There is often a reason for something being setup the way it is or there's some history
|
||||
behind it. "Have we considered switching from foo to bar?" is great, "Why are you using foo! bar is better, we should switch to it right now"
|
||||
is not.
|
||||
|
||||
* Keep in mind many of the infrastructure folks are busy, so do try and avoid 'pinging' them unless there's a specific need or you know they are
|
||||
active in channel. Many people have a IRC 'trigger' that notifies them when someone mentions their nick.
|
||||
|
||||
* Being active in IRC and asking questions is a great way to find out how things are setup and gain more trust.
|
||||
|
||||
* Watching discussion in IRC can often lead to some topic or area you might be interested in helping out with.
|
||||
If so, please feel free to chime in in channel that you would be interested in helping out and ask how you could
|
||||
do so.
|
||||
|
||||
* IRC channel #fedora-admin is bridged to https://chat.fedoraproject.org/#/room/#admin:fedoraproject.org[Fedora Infrastructure Matrix room]
|
||||
and #fedora-apps is bridged to https://chat.fedoraproject.org/#/room/#apps:fedoraproject.org[Fedora Apps Matrix room].
|
||||
These rooms belongs to the https://chat.fedoraproject.org[Fedora Matrix servers].
|
||||
|
||||
== Further information
|
||||
|
||||
For further information on this group, please ask in #fedora-admin on irc.libera.chat, the
|
||||
https://chat.fedoraproject.org/#/room/#admin:fedoraproject.org[Fedora Infrastructure Matrix room] and/or
|
||||
the fedora infrastructure xref:index.adoc#_mailing_list[ mailing list].
|
||||
|
||||
Ansible documentation is available at http://docs.ansible.com/
|
130
modules/ROOT/pages/gettingstarted.adoc
Normal file
130
modules/ROOT/pages/gettingstarted.adoc
Normal file
|
@ -0,0 +1,130 @@
|
|||
= Help Wanted
|
||||
|
||||
We're looking for dedicated and energetic people to join the fun times
|
||||
in the Fedora Infrastructure team. What fun stuff will you do to support
|
||||
and grow the Fedora community?
|
||||
|
||||
* You will help design and implement highly available and fault-tolerant
|
||||
systems
|
||||
* Fix system issues for grateful Fedora developers
|
||||
* Maintain the servers that make the Fedora Project possible
|
||||
* Create and maintain custom tools and applications to automate systems
|
||||
maintenance
|
||||
* Create and maintain tools and applications to enhance and grow the
|
||||
Fedora community
|
||||
|
||||
The skills you should possess or be willing to learn to do this work
|
||||
include:
|
||||
|
||||
* Being polite
|
||||
* Being patient
|
||||
* How to help fellow hackers
|
||||
* How to write systems administration scripts
|
||||
* How to write web applications
|
||||
** We primarily use Python, SQL, and associated technologies
|
||||
** Other equivalent technologies are welcome
|
||||
** We can especially use skills in this area or folks that are willing
|
||||
to learn
|
||||
* How the Fedora Project works "behind the scenes"
|
||||
|
||||
It would be great if
|
||||
|
||||
* You have previous systems admin experience
|
||||
* Have access to your own testing machines
|
||||
** Our resources are limited, especially for testing!
|
||||
* Work in other areas of Fedora like packaging or documentation
|
||||
|
||||
== Getting Started
|
||||
|
||||
See below for a list of steps or head down to the xref:gettingstarted.adoc#_quickstart[Quick
|
||||
Start] section if you just want to submit a single change or fix.
|
||||
|
||||
== First steps
|
||||
|
||||
* First you will need to read through and understand
|
||||
https://docs.fedoraproject.org/en-US/commops/contribute/successful-contributor/[how
|
||||
to be a successful contributor].
|
||||
* Next you will need to create a https://docs.fedoraproject.org/en-US/fedora-accounts/user/[
|
||||
Fedora Account]:
|
||||
** This account will be used for just about everything you do as a
|
||||
member of the Fedora Community
|
||||
** You will need it to sign the https://fedoraproject.org/wiki/Legal:Fedora_Project_Contributor_Agreement[FPCA]
|
||||
which is required to contribute to the Fedora Community
|
||||
** You will need it to login to various systems associated with the Infrastructure Group
|
||||
** You will need it to upload code changes, make changes to this wiki and etc.
|
||||
* After you have created your account and signed the FPCA, you should then subscribe to the
|
||||
https://lists.fedoraproject.org/admin/lists/infrastructure.lists.fedoraproject.org/[Fedora
|
||||
Infrastructure Mailing List].
|
||||
** This is the mailing list you will use to send your introduction email to the Fedora
|
||||
Infrastructure Team as well as communicate with other team members on a regular basis.
|
||||
** When you are ready to send a mailto:infrastructure@lists.fedoraproject.org[introduction to
|
||||
the group], your subject should be 'Meeting Agenda Item: Introduction _Your Name_'.
|
||||
The message body should include:
|
||||
*** Your IRC/Matrix handle
|
||||
**** https://fedoraproject.org/wiki/How_to_use_IRC[_What's this?_]
|
||||
**** https://fedoramagazine.org/beginners-guide-irc[Beginner's Guide to IRC]
|
||||
**** https://fedoramagazine.org/join-the-conversation/[Fedora's Matrix instance at chat.fedoraproject.org]
|
||||
*** What skills you have to offer and which you would like to learn. This can include...
|
||||
**** Programming languages you are familiar with or have used
|
||||
**** Systems administration skills, certifications, and technologies you have or have used (or wish to learn)
|
||||
**** Any associations you have (e.g. local hackerspace/makerspace, Linux User Groups, employer, etc.)
|
||||
** What you want to learn
|
||||
*** What you would like to work on and quite possibly which
|
||||
http://pagure.io/fedora-infrastructure/issues[outstanding issues] you would like to help resolve
|
||||
*** Look at our https://fedoraproject.org/easyfix/#fedora-infrastructure[Fedora Infrastructure Easyfix]
|
||||
issues for one that is of interest.
|
||||
** Any initial questions you have for the team
|
||||
*** Look at the https://docs.fedoraproject.org/en-US/infra/sysadmin_guide/[Fedora
|
||||
Infrastructure Best Practices] document
|
||||
*** Be patient, as sometimes folks are busy and might not reply to your email quickly.
|
||||
You may get a faster response on IRC.
|
||||
*** join the #fedora-admin channel on IRC and attend the next IRC meeting.
|
||||
*** Watch http://fedoramagazine.org/?p=642[some videos] intended to introduce new contributors to
|
||||
the team.
|
||||
|
||||
== What is next?
|
||||
|
||||
After you've completed the steps outlined in the xref:gettingstarted.adoc#_first_steps[First steps
|
||||
section] you should:
|
||||
|
||||
* Regularly attend the
|
||||
https://fedoraproject.org/wiki/Infrastructure/Meetings[Weekly Meetings]
|
||||
on IRC/Matrix and be sure to introduce yourself the first time you attend. There is a section at the
|
||||
start of the meeting where you can give a short introduction of yourself to the rest of the team.
|
||||
* Take some time to learn about the https://apps.fedoraproject.org/[services]
|
||||
the Fedora Infrastructure Group develops, deploys and maintains.
|
||||
* Ask about joining the xref:apprentice.adoc[Fedora Infrastructure Apprentice] (fi-apprentice) group.
|
||||
* Read up on https://docs.fedoraproject.org/en-US/infra/sysadmin_guide/#_standard_operating_procedures[SOPs]
|
||||
you find interesting. These are a good point of reference for hosts related to an app. They give an overview
|
||||
of how things work for that app.
|
||||
* Idle in IRC and chime in with questions or offers to help when you see an interesting problem being discussed.
|
||||
|
||||
If you don't have the time to be involved on a regular basis at this point, please feel free to watch over
|
||||
things and report bugs and RFEs as you see fit. Showing interest now is a great way to make it easier to
|
||||
join the team's activities later!
|
||||
|
||||
== QuickStart
|
||||
|
||||
* If you just want to make a single change or fix a single issue, then
|
||||
just jump right in at attach a patch for it to the existing issue, or
|
||||
post a patch to the mailing list. Note that we still would like you to
|
||||
create an account and sign the FPCA so we can properly license your
|
||||
contributions.
|
||||
|
||||
== How the team works
|
||||
|
||||
The Fedora Infrastructure Group consists of volunteers and Red Hat employees. Our preferred
|
||||
method of communication is IRC on Libera.Chat in channel though we also heavily use the Fedora Mailing
|
||||
List. We also have a Matrix room dedicated to us https://chat.fedoraproject.org/#/room/#admin:fedoraproject.org[#admin].
|
||||
We try to be as transparent as possible and default to open.
|
||||
|
||||
New members are encouraged to join the list, IRC, Matrix and attend meetings.
|
||||
|
||||
Asking questions (in any of our public areas: IRC, Matrix, lists, meetings) is encouraged. Unless there's an outage
|
||||
or people are busy we are happy to try and explain how something is setup or works.
|
||||
|
||||
The team is a meritocracy, which means those people who solve issues and do work are given more privileges over time. In
|
||||
general don't worry about the access and privileges, instead, try and solve problems and prove that you will be around
|
||||
and reliable over time and you will be setup with what you need to do that work. Since we are a small team we don't
|
||||
usually have the cycles to do full time mentoring of new contributors, so you will be expected to be a "self-starter"
|
||||
and able to gather information on your own. We are happy to answer questions when you get stuck.
|
Loading…
Add table
Add a link
Reference in a new issue