Skip to content

Commit 9d6715b

Browse files
authored
Some updates to README, with restoration of separate make targets for (#10)
Fixes some typos and facts in README, and restores make targets for run-pulp3 and run-pulp-manager
1 parent 1f31a42 commit 9d6715b

File tree

2 files changed

+35
-13
lines changed

2 files changed

+35
-13
lines changed

Makefile

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ h help:
1414
"c|cover" "Run coverage for all tests" \
1515
"venv" "Create virtualenv" \
1616
"clean" "Clean workspace" \
17-
"demo" "Run demo environment"
17+
"run-pulp-manager" "Run Pulp Manager services for development" \
18+
"run-pulp3" "Run Pulp 3 primary and secondary servers" \
19+
"demo" "Run complete demo environment"
1820

1921
.PHONY : l lint
2022
l lint: venv
@@ -53,6 +55,27 @@ venv: requirements.txt
5355
pip install --upgrade pip; \
5456
pip install -r requirements.txt
5557

58+
.PHONY : run-pulp-manager
59+
run-pulp-manager:
60+
@echo "Starting Pulp Manager services for development..."
61+
@docker compose -f demo/docker-compose.yml up -d mariadb redis-manager
62+
@echo "Waiting for database to be ready..."
63+
@sleep 5
64+
@docker compose -f demo/docker-compose.yml up -d pulp-manager-api pulp-manager-worker pulp-manager-rq-dashboard
65+
@echo ""
66+
@echo "Pulp Manager services started!"
67+
@echo "API: http://localhost:8080/docs"
68+
@echo "RQ Dashboard: http://localhost:9181"
69+
70+
.PHONY : run-pulp3
71+
run-pulp3:
72+
@echo "Starting Pulp 3 primary and secondary servers..."
73+
@docker compose -f demo/docker-compose.yml up -d pulp-primary pulp-secondary
74+
@echo ""
75+
@echo "Pulp 3 servers started!"
76+
@echo "Primary: http://localhost:8000"
77+
@echo "Secondary: http://localhost:8001"
78+
5679
.PHONY : demo
5780
demo: venv
5881
@echo "Setting up demo environment..."

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ a primary/secondary setup.
1212

1313
## Why Pulp Manager?
1414

15-
Pulp Manager provides centralized orchestration of a clustger of Pulp3
16-
instances and is particularly usfeful for organizations with
15+
Pulp Manager provides centralized orchestration of a cluster of Pulp3
16+
instances. It is particularly useful for organizations with
1717
multi-tiered or multi-zone deployments who need coordinated syncs
1818
between primary and secondary servers.
1919

@@ -227,7 +227,7 @@ Defines authentication allowed against the API
227227
- `jwt_algorithm`: Algorithm to use to encrypt JWT tokens
228228
- `jwt_token_lifetime_mins`: Number of minutes JWT is valid for
229229
- `admin_group`: Directory group user must be a member of to carry out
230-
priveldged actions agains the API
230+
privileged actions against the API
231231
- `require_jwt_auth`: Boolean whether to require JWT authentication for
232232
protected API endpoints. Set to false for local development environments
233233
where authentication is not needed. Defaults to true
@@ -304,7 +304,7 @@ pulp_servers:
304304
repo_groups:
305305
external_repos:
306306
schedule: "0 0 * * *"
307-
max_conccurent_sync: 2
307+
max_concurrent_sync: 2
308308
max_runtime: "6h"
309309
snapshot_support:
310310
max_concurrent_snapshots: 2
@@ -314,7 +314,7 @@ pulp_servers:
314314
repo_groups:
315315
external_repos:
316316
schedule: "0 6 * * *"
317-
max_conccurent_sync: 2
317+
max_concurrent_sync: 2
318318
max_runtime: "6h"
319319
pulp_master: pulp3mast1.example.com
320320
@@ -359,10 +359,10 @@ credentials and repo groups to sync.
359359
when the job is run
360360
- `max_runtime`: How long the job should run for before it is
361361
cancelled
362-
- `pulp_primary` (Optional): If the pulp server is synching the
362+
- `pulp_master` (Optional): If the pulp server is synching the
363363
repos from a pulp primary, specify the name of the pulp
364364
server. This needs to exist in the pulp_servers config so that the
365-
list of repos on the server can be retreived via the API
365+
list of repos on the server can be retrieved via the API
366366
- `snapshot_support`: specifies if snapshots can be run against the
367367
pulp server, value is a dict
368368
- `max_concurrent_snapshots`: number of repos that can snapshotted
@@ -499,8 +499,7 @@ execute the following command in your terminal:
499499
```shell
500500
make run-pulp-manager
501501
```
502-
This command orchestrates the setup by utilizing dockercompose-local.yml to start all necessary services. It also triggers the
503-
building of Docker images if they are not found or if there are updates to the images since the last build.
502+
This command starts the Pulp Manager API, worker, and RQ dashboard services along with their dependencies (MariaDB and Redis). It uses the demo/docker-compose.yml configuration.
504503

505504
For local authentication, the Pulp manager utilizes the password
506505
specified for pulp3 in local_config.ini and the username defined in
@@ -540,13 +539,13 @@ need to stop and restart the entire environment every time you modify
540539
a file.
541540

542541

543-
5. **Starting Pulp 3 Environment**
542+
5. **Starting Pulp 3 Environment**
544543

545-
For development that requires Pulp 3, you can start the Pulp 3 environment locally using Docker Compose. Run the following command in your terminal:
544+
For development that requires Pulp 3, you can start the Pulp 3 environment. Run the following command in your terminal:
546545
```
547546
make run-pulp3
548547
```
549-
This command makes use of dockercompose-pulp3.yml to bring up the Pulp 3 services. It's particularly useful for testing integrations with Pulp 3 or when working on features that depend on Pulp 3 services.
548+
This command starts the Pulp 3 primary and secondary servers using the demo/docker-compose.yml configuration. It's particularly useful for testing integrations with Pulp 3 or when working on features that depend on Pulp 3 services.
550549

551550
#### When to Use make run-pulp-manager Again:
552551

0 commit comments

Comments
 (0)