From 2688bb6d5788a3865903f4c8b72d8bea47c2a604 Mon Sep 17 00:00:00 2001 From: Gerrod Ubben Date: Tue, 19 Oct 2021 19:01:37 -0400 Subject: [PATCH] Add workflows documentation page fixes: #395 --- CHANGES/395.doc | 1 + docs/supported_workflows.md | 352 ++++++++++++++++++++++++++++++++++++ 2 files changed, 353 insertions(+) create mode 100644 CHANGES/395.doc create mode 100644 docs/supported_workflows.md diff --git a/CHANGES/395.doc b/CHANGES/395.doc new file mode 100644 index 000000000..cbb221c40 --- /dev/null +++ b/CHANGES/395.doc @@ -0,0 +1 @@ +Added Supported Worklows page to detail the workflows and features of the CLI. diff --git a/docs/supported_workflows.md b/docs/supported_workflows.md new file mode 100644 index 000000000..4cf48991a --- /dev/null +++ b/docs/supported_workflows.md @@ -0,0 +1,352 @@ +# Supported Workflows + +`pulp-cli` is still in beta, so the features and workflows listed here are subject to change. +Currently `pulp-cli` supports 5 versions of `pulpcore` from 3.11-3.16 and 5 of Pulp's plugins: +`pulp_ansible`, `pulp_container`, `pulp_file`, `pulp_python` and `pulp_rpm`. Some of Pulp's other +plugins can be added to the CLI through CLI plugins, check out [CLI plugins](index) for more information. + +## pulpcore + +Pulpcore commands require a minimum version of 3.11. Not every command is supported for all +`pulpcore` versions. Run `pulp status` to check your connection to Pulp and see currently +installed plugins. + +### Workflows + +The CLI currently supports the following workflows: +* [Uploading Artifacts](https://docs.pulpproject.org/pulpcore/workflows/upload-publish.html) +* [Creating, Syncing, Distributing Content](https://docs.pulpproject.org/pulpcore/workflows/exposing-content.html) +* [Exporting Content](https://docs.pulpproject.org/pulpcore/workflows/import-export.html#exporting) +* [Labeling Resources](https://docs.pulpproject.org/pulpcore/workflows/labels.html) + +### Features + +This table lists *some* of the currently available commands for `pulpcore`. For full list run +`pulp --help`. + +| Access Policy
`access-policy` | Artifact
`artifact` | Content Guards
`content-guard` | Exports Pulp
`export pulp` | Groups
`group` | Signing Service
`signing-service` | Task
`task` | Users
`user` | +|:--------------------------------------:|:---------------------------------:|:------------------------------------------:|:--------------------------------------:|:-----------------------------------------------------:|:----------------------------------------:|:-------------------------------:|:-----------------------------:| +| [List Access Polices][c0]
`list` | [List Artifacts][c3]
`list` | [List Content Guards][c7]
`list` | [List Pulp Exports][c15]
`list` | [List Groups][c19]
'list' | [List Signing Services][c29]
`list` | [List Tasks][c31]
`list` | [List Users][c35]
`list` | +| [Inspect Access Policy][c1]
`show` | [Inspect Artifact][c4]
`show` | [List RBAC Guards][c8]
`rbac list` | [Inspect Pulp Export][c16]
`show` | [Inspect Group][c20]
'show' | [Inspect Signing Service][c30]
`show` | [Inspect Task][c32]
`show` | [Inspect User][c36]
`show` | +| [Update Access Policy][c2]
`update` | [Create Artifact][c5]
`upload` | [Inspect RBAC Guard][c9]
`rbac show` | [Create Pulp Export][c17]
`run` | [Create Group][c21]
`create` | | [Cancel Task][c33]
`cancel` | | +| | | [Create RBAC Guard][c10]
`rbac create` | [Delete Pulp Export][c18]
`destroy` | [Delete Group][c22]
`destroy` | | [Delete Task][c34]
`destroy` | | +| | | [Update RBAC Guard][c11]
`rbac update` | | [Group List Permissions][c23]
`permission list` | | | | +| | | [Delete RBAC Guard][c12]
`rbac destroy` | | [Group Add Permission][c24]
`permission add` | | | | +| | | [Add Permission][c13]
`rbac assign` | | [Group Remove Permission][c25]
`permission remove` | | | | +| | | [Remove Permission][c14]
`rbac remove` | | [Group List Users][c26]
`user list` | | | | +| | | | | [Group Add User][c27]
`user add` | | | | +| | | | | [Group Remove user][c28]
`user remove` | | | | + +[c0]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/access_policies_list +[c1]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/access_policies_read +[c2]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/access_policies_update +[c3]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/artifacts_list +[c4]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/artifacts_read +[c5]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/artifacts_create +[c7]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/contentguards_list +[c8]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/contentguards_core_rbac_list +[c9]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/contentguards_core_rbac_read +[c10]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/contentguards_core_rbac_create +[c11]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/contentguards_core_rbac_partial_update +[c12]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/contentguards_core_rbac_delete +[c13]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/contentguards_core_rbac_assign_permission +[c14]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/contentguards_core_rbac_remove_permission +[c15]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/exporters_core_pulp_exports_list +[c16]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/exporters_core_pulp_exports_read +[c17]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/exporters_core_pulp_exports_create +[c18]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/exporters_core_pulp_exports_delete +[c19]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/groups_list +[c20]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/groups_read +[c21]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/groups_create +[c22]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/groups_delete +[c23]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/groups_model_permissions_list +[c24]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/groups_model_permissions_create +[c25]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/groups_model_permissions_delete +[c26]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/groups_users_list +[c27]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/groups_users_create +[c28]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/groups_users_delete +[c29]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/signing_services_list +[c30]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/signing_services_read +[c31]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/tasks_list +[c32]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/tasks_read +[c33]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/tasks_cancel +[c34]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/tasks_delete +[c35]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/users_list +[c36]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/users_read +[c37]: https://docs.pulpproject.org/pulpcore/restapi.html#operation/users_permissions + +## pulp_ansible + +Ansible commands require minimum version of 0.7.0. The commands can be found under the `ansible` +subgroup. + +### Workflows + +The CLI currently supports the following workflows: +* [Sync/Upload/Distribute Role Content](https://docs.pulpproject.org/pulp_ansible/workflows/roles.html) +* [Sync/Upload/Distribute Collection Content](https://docs.pulpproject.org/pulp_ansible/workflows/collections.html) + +### Features + +This table lists the currently available commands for `pulp_ansible` and links their corresponding API calls. + +| Role/Collection Version Content
`content -t role/collection-version` | Ansible Distribution
`distribution` | Role/Collection Version Remote
`remote -t role/collection-version` | Ansible Repository
`repository` | Ansible Repository Version
`repository version` | Ansible Repository Content
`repository content` | +|:-----------------------------------------------------------------------:|:--------------------------------------------:|:---------------------------------------------------------------------:|:-------------------------------------------:|:--------------------------------------------------:|:--------------------------------------------------:| +| [List Role/Collection Version][0]
`list` | [List Ansible Distributions][3]
`list` | [List Role/Collection Remote][8]
`list` | [List Ansible Repositories][13]
`list` | [List Repository Versions][19]
`list` | [List Repository Content][0]
`list` | +| [Inspect Role/Collection Version][1]
`show` | [Inspect Ansible Distribution][4]
`show` | [Inspect Role/Collection Remote][9]
`show` | [Inspect Ansible Repository][14]
`show` | [Inspect Repository Version][20]
`show` | [Add Repository Content][23]
`add` | +| [Create Role/Collection Version][2]
`upload` | [Create Ansible Distribution][5]
`create` | [Create Role/Collection Remote][10]
`create` | [Create Ansible Repository][15]
`create` | [Repair Repository Version][21]
`repair` | [Remove Repository Content][23]
`remove` | +| | [Update Ansible Distribution][6]
`update` | [Update Role/Collection Remote][11]
`update` | [Update Ansible Repository][16]
`update` | [Delete Repository Version][22]
`destroy` | [Modify Repository Content][23]
`modify` | +| | [Delete Ansible Distribution][7]
`destroy`| [Delete Role/Collection Remote][12]
`destroy` | [Delete Ansible Repository][17]
`destroy`| | | +| | | | [Sync Ansible Repository][18]
`sync` | | | + +[0]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/content_ansible_collection_versions_list +[1]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/content_ansible_collection_versions_read +[2]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/content_ansible_collection_versions_create +[3]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/distributions_ansible_ansible_list +[4]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/distributions_ansible_ansible_read +[5]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/distributions_ansible_ansible_create +[6]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/distributions_ansible_ansible_partial_update +[7]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/distributions_ansible_ansible_delete +[8]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/remotes_ansible_collection_list +[9]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/remotes_ansible_collection_read +[10]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/remotes_ansible_collection_create +[11]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/remotes_ansible_collection_partial_update +[12]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/remotes_ansible_collection_delete +[13]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/repositories_ansible_ansible_list +[14]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/repositories_ansible_ansible_read +[15]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/repositories_ansible_ansible_create +[16]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/repositories_ansible_ansible_partial_update +[17]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/repositories_ansible_ansible_delete +[18]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/repositories_ansible_ansible_sync +[19]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/repositories_ansible_ansible_versions_list +[20]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/repositories_ansible_ansible_versions_read +[21]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/repositories_ansible_ansible_versions_repair +[22]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/repositories_ansible_ansible_versions_delete +[23]: https://docs.pulpproject.org/pulp_ansible/restapi.html#operation/repositories_ansible_ansible_modify + + +## pulp_container + +Container commands require `pulp_container` minimum version of 2.3.0. The commands can be found +under the `container` subgroup. + +### Workflows + +The CLI currently supports the following workflows: +* [Sync Container Images](https://docs.pulpproject.org/pulp_container/workflows/sync.html) +* [Distribute Container Images](https://docs.pulpproject.org/pulp_container/workflows/host.html) + +### Features + +This table lists the currently available commands for `pulp_container` and links their corresponding API calls. + +| Container Namespaces
`namespace` | Container Distribution
`distribution` | Container Version Remote
`remote` | Container/Push Repository
`repository -t container/push` | Container/Push Repository Version
`repository -t container/push version` | +|:---------------------------------------------:|:------------------------------------------------:|:------------------------------------------:|:------------------------------------------------------------:|:---------------------------------------------------------------------------:| +| [List Container Namespaces][100]
`list` | [List Container Distributions][103]
`list` | [List Container Remote][108]
`list` | [List Container/Push Repositories][113]
`list` | [List Repository Versions][119]
`list` | +| [Inspect Container Namespace][101]
`show` | [Inspect Container Distribution][104]
`show` | [Inspect Container Remote][109]
`show` | [Inspect Container/Push Repository][114]
`show` | [Inspect Repository Version][120]
`show` | +| [Create Container Namespace][102]
`create` | [Create Container Distribution][105]
`create` | [Create Container Remote][110]
`create` | [Create Container Repository][115]
`create` | [Repair Repository Version][121]
`repair` | +| [Delete Container Namespace][123]
`destroy`| [Update Container Distribution][106]
`update` | [Update Container Remote][111]
`update` | [Update Container/Push Repository][116]
`update` | [Delete Repository Version][122]
`destroy` | +| | [Delete Container Distribution][107]
`destroy`| [Delete Container Remote][112]
`destroy`| [Delete Container Repository][117]
`destroy` | | +| | | | [Sync Container Repository][118]
`sync` | | + +[123]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/pulp_container_namespaces_destroy +[100]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/content_container_namespaces_list +[101]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/content_container_namespaces_read +[102]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/content_container_namespaces_create +[103]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/distributions_container_container_list +[104]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/distributions_container_container_read +[105]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/distributions_container_container_create +[106]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/distributions_container_container_partial_update +[107]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/distributions_container_container_delete +[108]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/remotes_container_container_list +[109]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/remotes_container_container_read +[110]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/remotes_container_container_create +[111]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/remotes_container_container_partial_update +[112]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/remotes_container_container_delete +[113]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/repositories_container_container_list +[114]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/repositories_container_container_read +[115]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/repositories_container_container_create +[116]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/repositories_container_container_partial_update +[117]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/repositories_container_container_delete +[118]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/repositories_container_container_sync +[119]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/repositories_container_container_versions_list +[120]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/repositories_container_container_versions_read +[121]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/repositories_container_container_versions_repair +[122]: https://docs.pulpproject.org/pulp_container/restapi.html#operation/repositories_container_container_versions_delete + + +## pulp_file + +File commands require `pulp_file` minimum version of 1.6.0. The commands can be found under the `file` +subgroup. + +### Workflows + +The CLI currently supports the following workflows: +* [Sync File Content](https://docs.pulpproject.org/pulp_file/workflows/sync.html) +* [Upload File Content](https://docs.pulpproject.org/pulp_file/workflows/upload.html) +* [Distribute File Content](https://docs.pulpproject.org/pulp_file/workflows/publish-host.html) +* [Alternative Content Sources](https://docs.pulpproject.org/pulp_file/workflows/alternate-content-source.html) + +### Features + +This table lists the currently available commands for `pulp_file` and links their corresponding API calls. + +| File Alternative Content Sources
`acs` | File Content
`content` | File Distribution
`distribution` | File Publication
`publication` | File Remote
`remote` | File Repository
`repository` | File Repository Version
`repository version` | File Repository Content
`repository content` | +|:---------------------------------------------:|:------------------------------:|:--------------------------------------------:|:-------------------------------------------:|:--------------------------------------:|:------------------------------------------:|:-----------------------------------------------:|:-----------------------------------------------:| +| [List File ACS][224]
`list` | [List File][200]
`list` | [List File Distributions][203]
`list` | [List File Publications][230]
`list` | [List File Remote][208]
`list` | [List File Repositories][213]
`list` | [List Repository Versions][219]
`list` | [List Repository Content][200]
`list` | +| [Inspect File ACS][225]
`show` | [Inspect File][201]
`show` | [Inspect File Distribution][204]
`show` | [Inspect File Publication][231]
`show` | [Inspect File Remote][209]
`show` | [Inspect File Repository][214]
`show` | [Inspect Repository Version][220]
`show` | [Add Repository Content][223]
`add` | +| [Create File ACS][226]
`create` | [Create File][202]
`upload` | [Create File Distribution][205]
`create` | [Create File Publication][232]
`create` | [Create File Remote][210]
`create` | [Create File Repository][215]
`create` | [Repair Repository Version][221]
`repair` | [Remove Repository Content][223]
`remove` | +| [Update File ACS][227]
`update/add/remove` | | [Update File Distribution][206]
`update` | [Delete File Publication][233]
`destroy` | [Update File Remote][211]
`update` | [Update File Repository][216]
`update` | [Delete Repository Version][222]
`destroy` | [Modify Repository Content][223]
`modify` | +| [Delete File ACS][228]
`destroy` | | [Delete File Distribution][207]
`destroy` | | [Delete File Remote][212]
`destroy` | [Delete File Repository][217]
`destroy` | | | +| [Refresh File ACS][229]
`refresh` | | | | | [Sync File Repository][218]
`sync` | | | + +[200]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/content_file_files_list +[201]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/content_file_files_read +[202]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/content_file_files_create +[203]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/distributions_file_file_list +[204]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/distributions_file_file_read +[205]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/distributions_file_file_create +[206]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/distributions_file_file_partial_update +[207]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/distributions_file_file_delete +[208]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/remotes_file_collection_list +[209]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/remotes_file_collection_read +[210]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/remotes_file_collection_create +[211]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/remotes_file_collection_partial_update +[212]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/remotes_file_collection_delete +[213]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/repositories_file_file_list +[214]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/repositories_file_file_read +[215]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/repositories_file_file_create +[216]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/repositories_file_file_partial_update +[217]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/repositories_file_file_delete +[218]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/repositories_file_file_sync +[219]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/repositories_file_file_versions_list +[220]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/repositories_file_file_versions_read +[221]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/repositories_file_file_versions_repair +[222]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/repositories_file_file_versions_delete +[223]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/repositories_file_file_modify +[224]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/acs_file_file_list +[225]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/acs_file_file_read +[226]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/acs_file_file_create +[227]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/acs_file_file_partial_update +[228]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/acs_file_file_delete +[229]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/acs_file_file_refresh +[230]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/publications_file_file_list +[231]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/publications_file_file_read +[232]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/publications_file_file_create +[233]: https://docs.pulpproject.org/pulp_file/restapi.html#operation/publications_file_file_delete + + +## pulp_python + +Python commands require `pulp_python` minimum version of 3.1.0. The commands can be found under the `python` +subgroup. + +### Workflows + +The CLI currently supports the following workflows: +* [Sync Python Packages](https://docs.pulpproject.org/pulp_python/workflows/sync.html) +* [Upload Python Packages](https://docs.pulpproject.org/pulp_python/workflows/upload.html) +* [Distribute Python Packages](https://docs.pulpproject.org/pulp_python/workflows/publish.html) + +### Features + +This table lists the currently available commands for `pulp_python` and links their corresponding API calls. + +| Python Content
`content` | Python Distribution
`distribution` | Python Publication
`publication` | Python Remote
`remote` | Python Repository
`repository` | Python Repository Version
`repository version` | Python Repository Content
`repository content` | +|:-------------------------------:|:---------------------------------------------:|:--------------------------------------------:|:--------------------------------------:|:-------------------------------------------:|:-------------------------------------------------:|:-------------------------------------------------:| +| [List Python][300]
`list` | [List Python Distributions][303]
`list` | [List Python Publication][324]
`list` |[List Python Remote][308]
`list` | [List Python Repositories][313]
`list` | [List Repository Versions][319]
`list` | [List Repository Content][300]
`list` | +| [Inspect Python][301]
`show` | [Inspect Python Distribution][304]
`show` | [Inspect Python Publication][325]
`show` |[Inspect Python Remote][309]
`show` | [Inspect Python Repository][314]
`show` | [Inspect Repository Version][320]
`show` | [Add Repository Content][323]
`add` | +| [Create Python][302]
`upload`| [Create Python Distribution][305]
`create` | [Create Python Publication][326]
`create` |[Create Python Remote][310]
`create` | [Create Python Repository][315]
`create` | [Repair Repository Version][321]
`repair` | [Remove Repository Content][323]
`remove` | +| | [Update Python Distribution][306]
`update` | [Delete Python Publication][327]
`destroy`|[Update Python Remote][311]
`update` | [Update Python Repository][316]
`update` | [Delete Repository Version][322]
`destroy` | [Modify Repository Content][323]
`modify` | +| | [Delete Python Distribution][307]
`destroy`| |[Delete Python Remote][312]
`destroy`| [Delete Python Repository][317]
`destroy`| | | +| | | | | [Sync Python Repository][318]
`sync` | | | + +[300]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/content_python_packages_list +[301]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/content_python_packages_read +[302]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/content_python_packages_create +[303]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/distributions_python_pypi_list +[304]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/distributions_python_pypi_read +[305]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/distributions_python_pypi_create +[306]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/distributions_python_pypi_partial_update +[307]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/distributions_python_pypi_delete +[308]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/remotes_python_python_list +[309]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/remotes_python_python_read +[310]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/remotes_python_python_create +[311]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/remotes_python_python_partial_update +[312]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/remotes_python_python_delete +[313]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/repositories_python_python_list +[314]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/repositories_python_python_read +[315]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/repositories_python_python_create +[316]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/repositories_python_python_partial_update +[317]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/repositories_python_python_delete +[318]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/repositories_python_python_sync +[319]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/repositories_python_python_versions_list +[320]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/repositories_python_python_versions_read +[321]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/repositories_python_python_versions_repair +[322]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/repositories_python_python_versions_delete +[323]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/repositories_python_python_modify +[324]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/publications_python_pypi_list +[325]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/publications_python_pypi_read +[326]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/publications_python_pypi_create +[327]: https://docs.pulpproject.org/pulp_python/restapi.html#operation/publications_python_pypi_delete + + +## pulp_rpm + +Python commands require `pulp_rpm` minimum version of 3.9.0. The commands can be found under the `rpm` +subgroup. + +### Workflows + +The CLI currently supports the following workflows: +* [Sync and Distribute RPM Packages](https://docs.pulpproject.org/pulp_rpm/workflows/create_sync_publish.html) +* [Upload RPM Packages](https://docs.pulpproject.org/pulp_rpm/workflows/upload.html) + +### Features + +This table lists the currently available commands for `pulp_rpm` and links their corresponding API calls. + +| RPM Alternative Content Sources
`acs` | RPM Packages Content
`content` | RPM Distribution
`distribution` | RPM Publication
`publication` | RPM Remote
`remote` | RPM Repository
`repository` | RPM Repository Version
`repository version` | RPM Repository Packages Content
`repository content` | +|:---------------------------------------------:|:------------------------------:|:--------------------------------------------:|:-------------------------------------------:|:--------------------------------------:|:------------------------------------------:|:-----------------------------------------------:|:-----------------------------------------------:| +| [List RPM ACS][424]
`list` | [List RPM][400]
`list` | [List RPM Distributions][403]
`list` | [List RPM Publications][430]
`list` | [List RPM Remote][408]
`list` | [List RPM Repositories][413]
`list` | [List Repository Versions][419]
`list` | [List Repository Content][400]
`list` | +| [Inspect RPM ACS][425]
`show` | [Inspect RPM][401]
`show` | [Inspect RPM Distribution][404]
`show` | [Inspect RPM Publication][431]
`show` | [Inspect RPM Remote][409]
`show` | [Inspect RPM Repository][414]
`show` | [Inspect Repository Version][420]
`show` | [Add Repository Content][423]
`add` | +| [Create RPM ACS][426]
`create` | [Create RPM][402]
`upload` | [Create RPM Distribution][405]
`create` | [Create RPM Publication][432]
`create` | [Create RPM Remote][410]
`create` | [Create RPM Repository][415]
`create` | [Repair Repository Version][421]
`repair` | [Remove Repository Content][423]
`remove` | +| [Update RPM ACS][427]
`update/add/remove` | | [Update RPM Distribution][406]
`update` | [Delete RPM Publication][433]
`destroy` | [Update RPM Remote][411]
`update` | [Update RPM Repository][416]
`update` | [Delete Repository Version][422]
`destroy` | [Modify Repository Content][423]
`modify` | +| [Delete RPM ACS][428]
`destroy` | | [Delete RPM Distribution][407]
`destroy` | | [Delete RPM Remote][412]
`destroy` | [Delete RPM Repository][417]
`destroy` | | | +| [Refresh RPM ACS][429]
`refresh` | | | | | [Sync RPM Repository][418]
`sync` | | | + +[400]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/content_rpm_packages_list +[401]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/content_rpm_packages_read +[402]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/content_rpm_packages_create +[403]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/distributions_rpm_rpm_list +[404]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/distributions_rpm_rpm_read +[405]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/distributions_rpm_rpm_create +[406]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/distributions_rpm_rpm_partial_update +[407]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/distributions_rpm_rpm_delete +[408]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/remotes_rpm_collection_list +[409]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/remotes_rpm_collection_read +[410]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/remotes_rpm_collection_create +[411]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/remotes_rpm_collection_partial_update +[412]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/remotes_rpm_collection_delete +[413]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/repositories_rpm_rpm_list +[414]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/repositories_rpm_rpm_read +[415]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/repositories_rpm_rpm_create +[416]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/repositories_rpm_rpm_partial_update +[417]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/repositories_rpm_rpm_delete +[418]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/repositories_rpm_rpm_sync +[419]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/repositories_rpm_rpm_versions_list +[420]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/repositories_rpm_rpm_versions_read +[421]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/repositories_rpm_rpm_versions_repair +[422]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/repositories_rpm_rpm_versions_delete +[423]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/repositories_rpm_rpm_modify +[424]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/acs_rpm_rpm_list +[425]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/acs_rpm_rpm_read +[426]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/acs_rpm_rpm_create +[427]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/acs_rpm_rpm_partial_update +[428]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/acs_rpm_rpm_delete +[429]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/acs_rpm_rpm_refresh +[430]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/publications_rpm_rpm_list +[431]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/publications_rpm_rpm_read +[432]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/publications_rpm_rpm_create +[433]: https://docs.pulpproject.org/pulp_rpm/restapi.html#operation/publications_rpm_rpm_delete