Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate docs to new stack #74

Merged
merged 1 commit into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file.
42 changes: 42 additions & 0 deletions staging_docs/admin/guides/extend-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Extend webserver support

## Adding support for remote repos running on custom ports

**Optional** By default, pulp is allowed to connect to web servers running on several standard or semi-standard ports: `80, 81, 443, 488, 8008, 8009, 8443, 9000`.

If any of the remote repos you are trying to connect to are hosted on non-standard
HTTP/HTTPS ports, you can configure Pulp to be able to talk to them like in the following example
for port `10011`.

`sudo semanage port -a -t http_port_t -p tcp 10011`

## Adding support for proxy servers running on custom ports

**Optional** By default, pulp is allowed to connect to web proxy servers on several standard or semi-standard ports: `3128, 3401, 4827, 8080, 8118, 8123, 10001-10010`.

If Pulp is configured to use a proxy server (in order to talk to remote repos), but the proxy
server is on a non-standard port, you can configure Pulp to be able to talk to them like in the
following example for port `10012`.

`sudo semanage port -a -t http_cache_port_t -p tcp 10012`

!!! note

If you get the following error:

`ValueError: Port tcp/10012 already defined`

That means that the port number is already labelled for some other purpose by SELinux. No change was
made to your system. Run this command instead (substitute `http_port_t` for remote repos):

`sudo semanage port -m -t http_cache_port_t -p tcp 10012`

!!! note

Technically Pulp can talk to any remote repo or proxy server running on any SELinux-recognized
ports for web servers or for proxy servers. (They are effectively one cumulative list.)

!!! note

To see the complete list of these ports currently recognized on your system, run:
`sudo semanage port -l | grep -E "^http_port_t|^http_cache_port_t|^squid_port_t" | grep tcp`
45 changes: 45 additions & 0 deletions staging_docs/admin/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Overview

The SELinux policy for Pulp 3.Y releases.

## Quickstart

### Building

```
sudo yum install -y selinux-policy-devel policycoreutils
git clone https://github.com/pulp/pulpcore-selinux
cd pulpcore-selinux

make -f /usr/share/selinux/devel/Makefile pulpcore_port.pp
make -f /usr/share/selinux/devel/Makefile pulpcore.pp
make -f /usr/share/selinux/devel/Makefile pulpcore_rhsmcertd.pp
```

### Installing

```
sudo semodule -i pulpcore_port.pp
sudo semodule -i pulpcore.pp
sudo semodule -i pulpcore_rhsmcertd.pp
```

### Labeling pulpcore_port

**Required**: You must label ports used by Pulp with `pulpcore_port_t` so that the proper type is assigned to the ports and Pulp is allowed to communicate on with the network correctly.

Apply the `pulpcore_port_t` SELinux type to ports 24816 and 24817 with:

`sudo semanage port -a -t pulpcore_port_t -p tcp 24816-24817`


### Uninstalling

Uninstall in the following order:

```
sudo semanage port -d -t pulpcore_port_t -p tcp 24816-24817
sudo semodule -r pulpcore_rhsmcertd
sudo semodule -r pulpcore
sudo semodule -r pulpcore_port
```
Empty file.
Empty file.
Empty file.
Empty file.
9 changes: 9 additions & 0 deletions staging_docs/dev/guides/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Release Guide

1. Bump the version number (`sed -i -e 's/1.2.1/1.2.2/g' *.te`).
1. Create a PR with all the changes above and merge it after a review.
1. Create a release on github. It will create the corresponding tag.
1. In that release, copy and paste the git commit titles since the last release
(`git shortlog 1.2.1...master --no-merges | grep -E "^(\s)+\w" | sed -e 's/ /*/'`)
1. Create a corresponding PR ([example](https://github.com/pulp/pulp_installer/pull/524)) for pulp_installer to use the new pulpcore-selinux tag.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't pulp-installer discontinued by now?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes - but in this pass, we're trying very hard to not-edit-for-content, but instead focus on location and conversion to .md. All the docs def need a content-pass (or four) - but we're trying not to hold up the new docs-stack waiting for it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I also didn't want to hold up docs with #75, but it'd be good to track follow up work.

(Bump `__pulp_selinux_version` in `roles/pulp_common/defaults/main.yml`)
Empty file added staging_docs/dev/learn/.gitkeep
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Loading