diff --git a/staging_docs/admin/guides/configure-signing-service.md b/staging_docs/admin/guides/configure-signing-service.md index a8ac242a..2132f26d 100644 --- a/staging_docs/admin/guides/configure-signing-service.md +++ b/staging_docs/admin/guides/configure-signing-service.md @@ -1,7 +1,9 @@ # Configure a Signing Service -> :information_source: Content Signing is in tech-preview and may change in backwards incompatible ways in future releases. +!!! warning + + Content Signing is in tech-preview and may change in backwards incompatible ways in future releases. It is possible to sign Pulp's metadata so that users can verify the authenticity of an object. This is done by enabling the *Signing Services* feature. The steps to enable it are: @@ -11,8 +13,10 @@ This is done by enabling the *Signing Services* feature. The steps to enable it * [create the signing services](#creating-the-signing-services) -See pulpcore documentation for details on ***Content Signing***: https://docs.pulpproject.org/pulpcore/workflows/signed-metadata.html#metadata-signing -See pulp_container documentation for details on ***Container Image Signing***: https://docs.pulpproject.org/pulp_container/workflows/sign-images.html +For further information, see: + +* [pulpcore documentation](site:pulpcore/docs/admin/guides/sign-metadata/) for details on ***Content Signing*** +* [pulp_container documentation](site:pulp_container/docs/admin/guides/sign-image/) for details on ***Container Image Signing*** ## Creating a gpg key @@ -211,4 +215,4 @@ $ podman exec pulp curl -Ls -u admin:password localhost:24817/pulp/api/v3/signin } ] } -``` \ No newline at end of file +``` diff --git a/staging_docs/admin/guides/deploy-multi-process-images.md b/staging_docs/admin/guides/deploy-multi-process-images.md index 5d4427e6..2f5ea662 100644 --- a/staging_docs/admin/guides/deploy-multi-process-images.md +++ b/staging_docs/admin/guides/deploy-multi-process-images.md @@ -20,17 +20,18 @@ Podman has been tested at versions as low as 1.6.4, which is available on CentOS This image contains [Pulp](https://github.com/pulp/pulpcore) and the following plugins currently: -- [pulp_ansible](https://docs.pulpproject.org/pulp_ansible/) -- [pulp-certguard](https://docs.pulpproject.org/pulp_certguard/) -- [pulp_container](https://docs.pulpproject.org/pulp_container/) -- [pulp_deb](https://docs.pulpproject.org/pulp_deb/) -- [pulp_file](https://docs.pulpproject.org/pulp_file/) -- [pulp_maven](https://docs.pulpproject.org/pulp_maven/) -- [pulp_python](https://docs.pulpproject.org/pulp_python/) -- [pulp_rpm](https://docs.pulpproject.org/pulp_rpm/) -- [pulp_ostree](https://docs.pulpproject.org/pulp_ostree/) - -This image can also function the same as the single-process image `pulp-minimal`. See the [Single-Process Images](single-process-images) page for usage. +- [pulp_ansible](site:pulp_ansible) +- [pulp-certguard](site:pulp_certguard) +- [pulp_container](site:pulp_container) +- [pulp_deb](site:pulp_deb) +- [pulp_file](site:pulp_file) +- [pulp_maven](site:pulp_maven) +- [pulp_python](site:pulp_python) +- [pulp_rpm](site:pulp_rpm) +- [pulp_ostree](site:pulp_ostree) + +This image can also function the same as the single-process image `pulp-minimal`. +See the [Single-Process Images](site:pulp-oci-images/docs/admin/reference/available-images/single-process-images/) page for usage. #### Tags @@ -52,7 +53,7 @@ This image can also function the same as the single-process image `pulp-minimal` This image contains Ansible [Galaxy](https://github.com/ansible/galaxy_ng). This image can also function the same as the single-process image `galaxy-minimal`. -See the [Single-Process Images](single-process-images) page for usage. +See the [Single-Process Images](site:pulp-oci-images/docs/admin/reference/available-images/single-process-images/) page for usage. Note that this name `galaxy` used to be for single-process images. Version tags `4.6.3` and earlier are single-process rather than multi-process. @@ -138,7 +139,8 @@ ANSIBLE_CONTENT_HOSTNAME='http://$(hostname):8080/pulp/content' CACHE_ENABLED=True" >> settings/settings.py ``` -* For a complete list of available settings for `settings.py`, see [the Pulpcore Settings](https://docs.pulpproject.org/pulpcore/configuration/settings.html). +* For a complete list of available settings for `settings.py`, see + [the Pulpcore Settings](site:pulpcore/docs/admin/reference/settings/). * These 4 directories `settings pulp_storage pgsql containers` must be preserved. `settings` has your settings, generated certificates, and generated database encrypted fields key. The @@ -204,7 +206,12 @@ curl localhost:8080/pulp/api/v3/status/ ### What to do after the Quickstart -To start working with Pulp, check out the [Workflows and Use Cases](https://docs.pulpproject.org/workflows/index.html). For individual plugin documentation, see [Pulp 3 Content Plugin Documentation](https://pulpproject.org/docs/#pulp-3-content-plugin-documentation). +To start working with Pulp, check out the [Workflows and Use Cases](https://github.com/pulp/pulpcore/issues/5593) +and explore individual Content Plugins documentation. + +If you are unsure what to pick first, try Python's +[Setup Your Own Pypi](site:pulp_python/docs/user/guides/pypi/) or RPM's +[Sync and Publish](site:pulp_rpm/docs/user/tutorials/create_sync_publish/). We recommend using [pulp-cli](https://github.com/pulp/pulp-cli) to interact with Pulp. If you have Python 3 installed on the host OS, you can run these commands to get started: @@ -236,13 +243,13 @@ To add one of them, modify the command you use to start pulp to include syntax l ### Adding Signing Services Administrators can add signing services to Pulp using the command line tools. Users may then associate the signing services with repositories that support content signing. -See [Signing Services](signing_script) documentation for more information. +See [Signing Services](site:pulp-oci-images/docs/admin/guides/configure-signing-service/) documentation for more information. ### Certificates and Keys -Follow the instructions from [certificates](certificates) documentation for more information about how to configure custom certificates. +Follow the instructions from [certificates](site:pulp-oci-images/docs/admin/guides/configure-certificates/) documentation for more information about how to configure custom certificates. -Check [database encryption](database-encryption) documentation for more information about the key to encrypt sensitive fields in the database. +Check [database encryption](site:pulp-oci-images/docs/admin/guides/configure-database-encryption/) documentation for more information about the key to encrypt sensitive fields in the database. ### Command to specify diff --git a/staging_docs/admin/guides/migrate-pulp-installer-to-multi-process.md b/staging_docs/admin/guides/migrate-pulp-installer-to-multi-process.md index 33000a83..624f4cf5 100644 --- a/staging_docs/admin/guides/migrate-pulp-installer-to-multi-process.md +++ b/staging_docs/admin/guides/migrate-pulp-installer-to-multi-process.md @@ -2,7 +2,8 @@ ## Overview -These instructions will migrate you from a [pulp_installer deployment](https://docs.pulpproject.org/pulp_installer/) to a [multi-process container deployment](multi-process-images). +These instructions will migrate you from a [pulp_installer deployment](https://github.com/pulp/pulp_installer) to a +[multi-process container deployment](site:pulp-oci-images/docs/admin/reference/available-images/multi-process-images/). The same host will be running Pulp, but in a container now. @@ -22,7 +23,8 @@ All of pulp_installer 3.23's supported distros are documented, but instructions ## Limitations -1. All of your existing installed plugins must be installed in the multi-process container image. See the list of installed plugins [here.](multi-process-images#available-images) +1. All of your existing installed plugins must be installed in the multi-process container image. See the list of installed plugins +[here](site:pulp-oci-images/docs/admin/reference/available-images/multi-process-images/#available-images). ## Prerequisites @@ -243,7 +245,9 @@ echo "net.ipv4.ip_unprivileged_port_start=443" | sudo tee /etc/sysctl.d/10-low_p ### Restore the database (EL7 or EL8 only) -Run the container with the normal [command](multi-process-images#starting-the-container), but with `-it` instead of `-detach`, and with `/bin/bash` as the specified command. We also omit the "--publish 8080:80" +Run the container with the normal +[command](site:pulp-oci-images/docs/admin/reference/available-images/multi-process-images/#starting-the-container), +but with `-it` instead of `-detach`, and with `/bin/bash` as the specified command. We also omit the "--publish 8080:80" ``` podman run -it \ --name pulp \ @@ -284,13 +288,17 @@ podman rm pulp ### Run the container like normal. -Run the container with the normal [command](multi-process-images#starting-the-container). +Run the container with the normal +[command](site:pulp-oci-images/docs/admin/reference/available-images/multi-process-images/#starting-the-container). + There are 2 migration-specific exceptions to the instructions on that page. The 1st exception is the port that Pulp listens on. -https is the default for pulp_installer, so see the https instructions on [that page](multi-process-images#starting-the-container) if you wish to continue running https. However, instead of specifying `--publish 8080:443` or `--publish 80:80`, specify `--publish 443:443`. This will keep Pulp listening on port 443, thus avoiding the need to reconfigure clients. This will be part of your new normal command. +https is the default for pulp_installer, so see the https instructions on +[that page](site:pulp-oci-images/docs/admin/reference/available-images/multi-process-images/#starting-the-container). +if you wish to continue running https. However, instead of specifying `--publish 8080:443` or `--publish 80:80`, specify `--publish 443:443`. This will keep Pulp listening on port 443, thus avoiding the need to reconfigure clients. This will be part of your new normal command. If you are not running https, the command below has been modified to listen on port 80 rather than 8080. `--publish 8080:80` has been replaced with `--publish 80:80`. This will be part of your new diff --git a/staging_docs/admin/reference/available-images/index.md b/staging_docs/admin/reference/available-images/index.md index afc7337d..91bae549 100644 --- a/staging_docs/admin/reference/available-images/index.md +++ b/staging_docs/admin/reference/available-images/index.md @@ -6,7 +6,7 @@ The available images can be divided into two types: - [Multi-Process Images](multi-process-images) - Images for running a [Pulp](https://github.com/pulp/pulpcore) or [Ansible Galaxy](https://github.com/ansible/galaxy_ng), as well as its [third-party services](#third-party-services), in a single Docker/Podman container. -- [Single-Process Images](single-process-images) - Images containing a single Pulp service each, which collectively make up a Pulp instance. They can be used via docker-compose or podman-compose, example [here](https://github.com/pulp/pulp-oci-images/tree/latest/images/compose). These images are also used by [pulp operator](https://docs.pulpproject.org/pulp_operator/). +- [Single-Process Images](single-process-images) - Images containing a single Pulp service each, which collectively make up a Pulp instance. They can be used via docker-compose or podman-compose, example [here](https://github.com/pulp/pulp-oci-images/tree/latest/images/compose). These images are also used by [pulp operator](site:pulp-operator). | Name | Description | | ---- | ----------- | diff --git a/staging_docs/admin/reference/available-images/multi-process-images.md b/staging_docs/admin/reference/available-images/multi-process-images.md index 2481dec5..d0abd0d2 100644 --- a/staging_docs/admin/reference/available-images/multi-process-images.md +++ b/staging_docs/admin/reference/available-images/multi-process-images.md @@ -20,17 +20,18 @@ Podman has been tested at versions as low as 1.6.4, which is available on CentOS This image contains [Pulp](https://github.com/pulp/pulpcore) and the following plugins currently: -- [pulp_ansible](https://docs.pulpproject.org/pulp_ansible/) -- [pulp-certguard](https://docs.pulpproject.org/pulp_certguard/) -- [pulp_container](https://docs.pulpproject.org/pulp_container/) -- [pulp_deb](https://docs.pulpproject.org/pulp_deb/) -- [pulp_file](https://docs.pulpproject.org/pulp_file/) -- [pulp_maven](https://docs.pulpproject.org/pulp_maven/) -- [pulp_python](https://docs.pulpproject.org/pulp_python/) -- [pulp_rpm](https://docs.pulpproject.org/pulp_rpm/) -- [pulp_ostree](https://docs.pulpproject.org/pulp_ostree/) - -This image can also function the same as the single-process image `pulp-minimal`. See the [Single-Process Images](single-process-images) page for usage. +- [pulp_ansible](site:pulp_ansible) +- [pulp-certguard](site:pulp_certguard) +- [pulp_container](site:pulp_container) +- [pulp_deb](site:pulp_deb) +- [pulp_file](site:pulp_file) +- [pulp_maven](site:pulp_maven) +- [pulp_python](site:pulp_python) +- [pulp_rpm](site:pulp_rpm) +- [pulp_ostree](site:pulp_ostree) + +This image can also function the same as the single-process image `pulp-minimal`. +See the [Single-Process Images](../single-process-images/) page for usage. #### Tags @@ -52,7 +53,7 @@ This image can also function the same as the single-process image `pulp-minimal` This image contains Ansible [Galaxy](https://github.com/ansible/galaxy_ng). This image can also function the same as the single-process image `galaxy-minimal`. -See the [Single-Process Images](single-process-images) page for usage. +See the [Single-Process Images](../single-process-images/) page for usage. Note that this name `galaxy` used to be for single-process images. Version tags `4.6.3` and earlier are single-process rather than multi-process. @@ -138,7 +139,8 @@ ANSIBLE_CONTENT_HOSTNAME='http://$(hostname):8080/pulp/content' CACHE_ENABLED=True" >> settings/settings.py ``` -* For a complete list of available settings for `settings.py`, see [the Pulpcore Settings](https://docs.pulpproject.org/pulpcore/configuration/settings.html). +* For a complete list of available settings for `settings.py`, + see [the Pulpcore Settings](site:pulpcore/docs/admin/reference/settings/). * These 4 directories `settings pulp_storage pgsql containers` must be preserved. `settings` has your settings, generated certificates, and generated database encrypted fields key. The @@ -204,7 +206,12 @@ curl localhost:8080/pulp/api/v3/status/ ### What to do after the Quickstart -To start working with Pulp, check out the [Workflows and Use Cases](https://docs.pulpproject.org/workflows/index.html). For individual plugin documentation, see [Pulp 3 Content Plugin Documentation](https://pulpproject.org/docs/#pulp-3-content-plugin-documentation). +To start working with Pulp, check out the [Workflows and Use Cases](https://github.com/pulp/pulpcore/issues/5593) +and explore individual Content Plugins documentation. + +If you are unsure what to pick first, try Python's +[Setup Your Own Pypi](site:pulp_python/docs/user/guides/pypi/) or RPM's +[Sync and Publish](site:pulp_rpm/docs/user/tutorials/create_sync_publish/). We recommend using [pulp-cli](https://github.com/pulp/pulp-cli) to interact with Pulp. If you have Python 3 installed on the host OS, you can run these commands to get started: @@ -244,13 +251,13 @@ To add one of them, modify the command you use to start pulp to include syntax l ### Adding Signing Services Administrators can add signing services to Pulp using the command line tools. Users may then associate the signing services with repositories that support content signing. -See [Signing Services](signing_script) documentation for more information. +See [Signing Services](site:pulp-oci-images/docs/admin/guides/configure-signing-service/) documentation for more information. ### Certificates and Keys -Follow the instructions from [certificates](../certificates) documentation for more information about how to configure custom certificates. +Follow the instructions from [certificates](site:pulp-oci-images/docs/admin/guides/configure-certificates/) documentation for more information about how to configure custom certificates. -Check [database encryption](../database-encryption) documentation for more information about the key to encrypt sensitive fields in the database. +Check [database encryption](site:pulp-oci-images/docs/admin/guides/configure-database-encryption/) documentation for more information about the key to encrypt sensitive fields in the database. ### Command to specify diff --git a/staging_docs/admin/reference/available-images/single-process-images.md b/staging_docs/admin/reference/available-images/single-process-images.md index 489f7c83..e4d89fce 100644 --- a/staging_docs/admin/reference/available-images/single-process-images.md +++ b/staging_docs/admin/reference/available-images/single-process-images.md @@ -1,6 +1,6 @@ # Single-Process Images -These images are currently used on [pulp operator](https://docs.pulpproject.org/pulp_operator/), but they can be used in docker-compose or podman-compose. You can find a compose example [here](https://github.com/pulp/pulp-oci-images/tree/latest/images/compose). +These images are currently used on [pulp operator](site:pulp-operator), but they can be used in docker-compose or podman-compose. You can find a compose example [here](https://github.com/pulp/pulp-oci-images/tree/latest/images/compose). ## pulp-minimal @@ -18,15 +18,15 @@ It is the reference on how this image can be used to create the 3 services/conta pulp-minimal is currently built with the following plugins: -- [pulp_ansible](https://docs.pulpproject.org/pulp_ansible/) -- [pulp-certguard](https://docs.pulpproject.org/pulp_certguard/) -- [pulp_container](https://docs.pulpproject.org/pulp_container/) -- [pulp_deb](https://docs.pulpproject.org/pulp_deb/) -- [pulp_file](https://docs.pulpproject.org/pulp_file/) -- [pulp_maven](https://docs.pulpproject.org/pulp_maven/) -- [pulp_python](https://docs.pulpproject.org/pulp_python/) -- [pulp_rpm](https://docs.pulpproject.org/pulp_rpm/) -- [pulp_ostree](https://docs.pulpproject.org/pulp_ostree/) +- [pulp_ansible](site:pulp_ansible) +- [pulp-certguard](site:pulp_certguard) +- [pulp_container](site:pulp_container) +- [pulp_deb](site:pulp_deb) +- [pulp_file](site:pulp_file) +- [pulp_maven](site:pulp_maven) +- [pulp_python](site:pulp_python) +- [pulp_rpm](site:pulp_rpm) +- [pulp_ostree](site:pulp_ostree) ### Tags diff --git a/staging_docs/admin/tutorials/quickstart.md b/staging_docs/admin/tutorials/quickstart.md index 568686f2..5cd1a9a1 100644 --- a/staging_docs/admin/tutorials/quickstart.md +++ b/staging_docs/admin/tutorials/quickstart.md @@ -5,12 +5,11 @@ Here are some common deployment scenarios, each with a guide on how to get start 1. To deploy to [K8s](https://kubernetes.io/), [EKS](https://docs.aws.amazon.com/eks/latest/userguide/what-is-eks.html), or [Openshift](https://www.redhat.com/en/technologies/cloud-computing/openshift) use the - [Pulp Operator](https://docs.pulpproject.org/pulp_operator/quickstart/) which was specially built + [Pulp Operator](site:pulp-operator/docs/admin/tutorials/quickstart-kubernetes/) which was specially built for this purpose. 2. Local [deployment via a single container](#single-container). This is for small deployments that don't need to scale beyond the hardware available to a single container. -3. Local [deployment with multiple containers using podman or docker compose]( - #podman-or-docker-compose). +3. Local [deployment with multiple containers using podman or docker compose](#podman-or-docker-compose). In all cases, after deployment see [what to do after the quickstart](#what-to-do-after-the-quickstart) to start using your installation. @@ -33,7 +32,8 @@ $ mkdir -p settings/certs pulp_storage pgsql containers $ echo "CONTENT_ORIGIN='http://$(hostname):8080'" >> settings/settings.py ``` -* For a complete list of available settings for `settings.py`, see [the Pulpcore Settings](https://docs.pulpproject.org/pulpcore/configuration/settings.html). +* For a complete list of available settings for `settings.py`, see + [the Pulpcore Settings](site:pulpcore/docs/admin/reference/settings/). * These 4 directories `settings`, `pulp_storage`, `pgsql`, `containers` must be preserved. `settings` has your settings, generated certificates, and generated database encrypted fields key. The @@ -174,4 +174,9 @@ pulp config create --username admin --base-url http://localhost:8080 --password ### Try out a workflow -To start working with Pulp, check out the [Workflows and Use Cases](https://docs.pulpproject.org/workflows/index.html). For individual plugin documentation, see [Pulp 3 Content Plugin Documentation](https://pulpproject.org/docs/#pulp-3-content-plugin-documentation). +To start working with Pulp, check out the [Workflows and Use Cases](https://github.com/pulp/pulpcore/issues/5593) +and explore individual Content Plugins documentation. + +If you are unsure what to pick first, try Python's +[Setup Your Own Pypi](site:pulp_python/docs/user/guides/pypi/) or RPM's +[Sync and Publish](site:pulp_rpm/docs/user/tutorials/create_sync_publish/).