Project

Profile

Help

Task #9150

As a Pulp user, I want to validate that my setup is working

Added by mcorr 2 months ago. Updated about 1 month ago.

Status:
NEW
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation
Sprint:
Quarter:
Q3-2021

Description

This has been reported in the Pulp Community Survey as a concern that some "Checks" documentation would help alleviate.

"how do I validate my setup is working." ... I've written my own checkout test cases to address this because it wasn't obvious how to reuse the Pulp CI checks.

Can we provide documentation as to how a user could reuse the Pulp CI checks? Alternatively, can we provide some guidance around how users can know when all is good?

History

#1 Updated by daviddavis 2 months ago

We have some basic app checks:

https://github.com/pulp/pulpcore/blob/master/pulpcore/app/checks.py

They use the django system check framework:

https://docs.djangoproject.com/en/3.2/topics/checks/

Maybe we could document how to run these checks and also add some more checks.

#2 Updated by daviddavis about 2 months ago

mcorr, can you be more explicit about what sorts of checks might benefit users?

Also, today during our pulpcore meeting we discussed relying on the status api (accessible at /pulp/api/v3/status/ and via the pulp status CLI command), which should give some picture about the health of the system (see example below). So maybe it's just worth documenting this?

{
  "versions": [
    {
      "component": "core",
      "version": "3.15.0.dev"
    },
    {
      "component": "file",
      "version": "1.9.0.dev"
    },
    {
      "component": "ansible",
      "version": "0.10.0.dev"
    }
  ],
  "online_workers": [
    {
      "pulp_href": "/pulp/api/v3/workers/2fc7dfd6-3d4d-4a3d-8b2a-a9f641fbc4d7/",
      "pulp_created": "2021-08-03T12:39:44.395610Z",
      "name": "211023@pulp3-source-fedora.crake.example.com",
      "last_heartbeat": "2021-08-03T13:56:49.351986Z"
    }
  ],
  "online_content_apps": [],
  "database_connection": {
    "connected": true
  },
  "redis_connection": {
    "connected": true
  },
  "storage": {
    "total": 42006183936,
    "used": 3561533440,
    "free": 36280442880
  }
}

#3 Updated by ttereshc about 1 month ago

  • Quarter set to Q3-2021

#4 Updated by mcorr about 1 month ago

Hi David. No idea why I didn't get notified of this!

The idea I had in my head was something like the Docker hello world scenario, where in their troubleshooting docs, you usually run that docker hello world command to see can you communicate with Docker and pull images, before you go hunting for a bigger problem.

Your suggestion looks good also!

Please register to edit this issue

Also available in: Atom PDF