Infrastructure/infra-docs-fpo
3
0
Fork 0
Code Issues 100 Pull requests 6 Projects Releases Packages Wiki Activity Actions

Fixing URLs and adding content taked from comments

Browse source
This commit is contained in:
Eduard Lucena 2023-07-24 16:28:34 -04:00 • committed by zlopez
parent 288573160b
commit 8b99f8e019
2 changed files with 38 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

34
modules/ROOT/pages/apprentice.adoc
View file

@ -9,9 +9,9 @@ apprentices to examine and gather info on problems, then propose solutions.
Members of the fi-apprentice group have ssh/shell access to many machines, but no sudo rights or ability 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 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] infrastructure documentation by sending pull requests to the [infra-docs-fpo](https://pagure.io/infra-docs-fpo)
repository. Access is via the bastion.fedoraproject.org machine and from there to each machine. See the 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 [SSH Access Infrastructure SOP](https://docs.fedoraproject.org/en-US/infra/sysadmin_guide/sshaccess/) for more
info. You can see a list of hosts that allow apprentice access by using: 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` `./scripts/hosts_with_var_set -i inventory/ -o ipa_client_shell_groups=fi-apprentice`
from an ansible repo checkout (see below). from an ansible repo checkout (see below).
@ -19,7 +19,7 @@ from an ansible repo checkout (see below).
== Nagios alerts == 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 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: [FMN notifications settings](https://apps.fedoraproject.org/notifications) or watch the Nagios web interface at:
https://admin.fedoraproject.org/nagios/ and https://nagios-external.fedoraproject.org/nagios/ 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”. Nagios access is now controlled by kerberos, so you will need to do a command with “kinit your_fas_name@@FEDORAPROJECT.ORG”.
@ -40,7 +40,7 @@ and ask questions, etc. The current list:
https://docs.fedoraproject.org/en-US/Community_Services_Infrastructure/1/html/Security_Policy/index.html 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. 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 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 refer to [standards for documenting CSI variables](https://fedoraproject.org/wiki/Standards_for_documenting_CSI_variables) before submitting patches
for ansible. for ansible.
* Our docs aren't all using the same template. See the https://pagure.io/infra-docs-fpo repo and propose patches * Our docs aren't all using the same template. See the https://pagure.io/infra-docs-fpo repo and propose patches
@ -52,7 +52,7 @@ them. Be sure to discuss in meeting or in a issue whatever you find.
== easyfix tickets == 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 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] fix. See the [pagure.io easyfix report](https://pagure.io/fedora-infrastructure/issues?status=Open&tags=easyfix)
=== Working on a ticket workflow === Working on a ticket workflow
@ -69,15 +69,16 @@ there and close it or rework it as needed. You can add to the next meeting agend
Most any task will require changes to ansible. You can check this out on batcave01.iad2.fedoraproject.org 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 (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 == IRC/Matrix 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: The primary ways the infrastructure team communicates are IRC and Matrix. 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. * 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. 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 * Try to avoid private messages to specific team members. Instead ask your questions in #fedora-admin or #fedora-noc on IRC and
allows anyone to help you out and also other folks to see the answer and peer review the answers you get. [Fedora Infrastructure Team"](https://chat.fedoraproject.org/#/room/#admin:fedoraproject.org) and ["Fedora Network Operation Center"](https://chat.fedoraproject.org/#/room/#noc:fedoraproject.org)
on Matrix 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 * 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" 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"
@ -86,20 +87,21 @@ 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 * 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. 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. * Being active in IRC/Matrix 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. * Watching discussion in IRC/Matrix 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 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. do so.
* IRC channel #fedora-admin is bridged to https://chat.fedoraproject.org/#/room/#admin:fedoraproject.org[Fedora Infrastructure Matrix room] * IRC channel #fedora-admin is bridged to [Fedora Infrastructure Matrix room](https://chat.fedoraproject.org/#/room/#admin:fedoraproject.org),
and #fedora-apps is bridged to https://chat.fedoraproject.org/#/room/#apps:fedoraproject.org[Fedora Apps Matrix room]. #fedora-apps is bridged to [Fedora Apps Matrix room](https://chat.fedoraproject.org/#/room/#apps:fedoraproject.org)
These rooms belongs to the https://chat.fedoraproject.org[Fedora Matrix servers]. and #fedora-nox is bridged to ["Fedora Network Operation Center"](https://chat.fedoraproject.org/#/room/#noc:fedoraproject.org).
These rooms belongs to the [Fedora Matrix servers](https://chat.fedoraproject.org).
== Further information == Further information
For further information on this group, please ask in #fedora-admin on irc.libera.chat, the 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 [Fedora Infrastructure Matrix room](https://chat.fedoraproject.org/#/room/#admin:fedoraproject.org) and/or
the fedora infrastructure xref:index.adoc#_mailing_list[ mailing list]. the fedora infrastructure xref:index.adoc#_mailing_list[mailing list].
Ansible documentation is available at http://docs.ansible.com/ Ansible documentation is available at http://docs.ansible.com/

46
modules/ROOT/pages/gettingstarted.adoc
View file

@ -42,44 +42,39 @@ Start] section if you just want to submit a single change or fix.
== First steps == First steps
* First you will need to read through and understand * First you will need to read through and understand
https://docs.fedoraproject.org/en-US/commops/contribute/successful-contributor/[how [how to be a successful contributor](https://docs.fedoraproject.org/en-US/commops/contribute/successful-contributor/).
to be a successful contributor]. * Next you will need to create a [Fedora Account](https://docs.fedoraproject.org/en-US/fedora-accounts/user/):
* 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 ** This account will be used for just about everything you do as a
member of the Fedora Community member of the Fedora Community
** You will need it to sign the https://fedoraproject.org/wiki/Legal:Fedora_Project_Contributor_Agreement[FPCA] ** You will need it to sign the [FPCA](https://fedoraproject.org/wiki/Legal:Fedora_Project_Contributor_Agreement)
which is required to contribute to the Fedora Community 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 login to various systems associated with the Infrastructure Group
** You will need it to upload code changes, make changes to this wiki and etc. ** 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 * 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 [Fedora Infrastructure Mailing List](https://lists.fedoraproject.org/admin/lists/infrastructure.lists.fedoraproject.org/)
Infrastructure Mailing List]. and you should check the [Infrastructure tag at Fedora Discussion](https://discussion.fedoraproject.org/tags/c/project/7/infrastructure-team).
** This is the mailing list you will use to send your introduction email to the Fedora ** 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. 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 ** When you are ready to send a [introduction to the group](mailto:infrastructure@lists.fedoraproject.org),
the group], your subject should be 'Meeting Agenda Item: Introduction _Your Name_'. ** your subject should be 'Meeting Agenda Item: Introduction _Your Name_'.
The message body should include: The message body should include:
*** Your IRC/Matrix handle *** Your IRC/Matrix handle
**** https://fedoraproject.org/wiki/How_to_use_IRC[_What's this?_] **** [_What's this?_](https://fedoraproject.org/wiki/How_to_use_IRC)
**** https://fedoramagazine.org/beginners-guide-irc[Beginner's Guide to IRC] **** [Beginner's Guide to IRC](https://fedoramagazine.org/beginners-guide-irc)
**** https://fedoramagazine.org/join-the-conversation/[Fedora's Matrix instance at chat.fedoraproject.org] **** [Fedora's Matrix instance at chat.fedoraproject.org](https://fedoramagazine.org/join-the-conversation/)
*** What skills you have to offer and which you would like to learn. This can include... *** 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 **** Programming languages you are familiar with or have used
**** Systems administration skills, certifications, and technologies you have or have used (or wish to learn) **** 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.) **** Any associations you have (e.g. local hackerspace/makerspace, Linux User Groups, employer, etc.)
** What you want to learn ** What you want to learn
*** What you would like to work on and quite possibly which *** What you would like to work on and quite possibly which [outstanding issues](http://pagure.io/fedora-infrastructure/issues) you would like to help resolve
http://pagure.io/fedora-infrastructure/issues[outstanding issues] you would like to help resolve *** Look at our [Fedora Infrastructure Easyfix](https://fedoraproject.org/easyfix/#fedora-infrastructure)
*** Look at our https://fedoraproject.org/easyfix/#fedora-infrastructure[Fedora Infrastructure Easyfix]
issues for one that is of interest. issues for one that is of interest.
** Any initial questions you have for the team ** Any initial questions you have for the team
*** Look at the https://docs.fedoraproject.org/en-US/infra/sysadmin_guide/[Fedora *** Look at the [Fedora Infrastructure Best Practices](https://docs.fedoraproject.org/en-US/infra/sysadmin_guide/) document
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.
*** 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. *** 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 *** Watch [some videos](http://fedoramagazine.org/?p=642) intended to introduce new contributors to
the team. the team.
== What is next? == What is next?
@ -87,14 +82,13 @@ the team.
After you've completed the steps outlined in the xref:gettingstarted.adoc#_first_steps[First steps After you've completed the steps outlined in the xref:gettingstarted.adoc#_first_steps[First steps
section] you should: section] you should:
* Regularly attend the * Regularly attend the [Weekly Meetings](https://fedoraproject.org/wiki/Infrastructure/Meetings)
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 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. 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] * Take some time to learn about the [services](https://docs.fedoraproject.org/en-US/infra/map_critical_services/)
the Fedora Infrastructure Group develops, deploys and maintains. the Fedora Infrastructure Group develops, deploys and maintains.
* Ask about joining the xref:apprentice.adoc[Fedora Infrastructure Apprentice] (fi-apprentice) group. * 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] * Read up on [SOPs](https://docs.fedoraproject.org/en-US/infra/sysadmin_guide/#_standard_operating_procedures)
you find interesting. These are a good point of reference for hosts related to an app. They give an overview 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. 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. * Idle in IRC and chime in with questions or offers to help when you see an interesting problem being discussed.
@ -115,10 +109,10 @@ contributions.
The Fedora Infrastructure Group consists of volunteers and Red Hat employees. Our preferred 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 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]. List. We also have a Matrix room dedicated to us [#admin](https://chat.fedoraproject.org/#/room/#admin:fedoraproject.org).
We try to be as transparent as possible and default to open. 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. New members are encouraged to join the list, use the discourse, IRC, Matrix and attend meetings.
Asking questions (in any of our public areas: IRC, Matrix, lists, meetings) is encouraged. Unless there's an outage 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. or people are busy we are happy to try and explain how something is setup or works.