mirror of
https://github.com/cisagov/manage.get.gov.git
synced 2025-08-13 13:09:41 +02:00
Add documentation
This commit is contained in:
parent
2846fea96f
commit
ea05de39f5
1 changed files with 28 additions and 0 deletions
|
@ -524,3 +524,31 @@ Example: `cf ssh getgov-za`
|
||||||
| 2 | **debug** | Increases logging detail. Defaults to False. |
|
| 2 | **debug** | Increases logging detail. Defaults to False. |
|
||||||
| 3 | **limitParse** | Determines how many domains to parse. Defaults to all. |
|
| 3 | **limitParse** | Determines how many domains to parse. Defaults to all. |
|
||||||
| 4 | **disableIdempotentCheck** | Boolean that determines if we should check for idempotence or not. Compares the proposed extension date to the value in TransitionDomains. Defaults to False. |
|
| 4 | **disableIdempotentCheck** | Boolean that determines if we should check for idempotence or not. Compares the proposed extension date to the value in TransitionDomains. Defaults to False. |
|
||||||
|
|
||||||
|
|
||||||
|
## Populate First Ready
|
||||||
|
This section outlines how to run the populate_first_ready script
|
||||||
|
|
||||||
|
### Running on sandboxes
|
||||||
|
|
||||||
|
#### Step 1: Login to CloudFoundry
|
||||||
|
```cf login -a api.fr.cloud.gov --sso```
|
||||||
|
|
||||||
|
#### Step 2: SSH into your environment
|
||||||
|
```cf ssh getgov-{space}```
|
||||||
|
|
||||||
|
Example: `cf ssh getgov-za`
|
||||||
|
|
||||||
|
#### Step 3: Create a shell instance
|
||||||
|
```/tmp/lifecycle/shell```
|
||||||
|
|
||||||
|
#### Step 4: Running the script
|
||||||
|
```./manage.py populate_first_ready --debug```
|
||||||
|
|
||||||
|
### Running locally
|
||||||
|
```docker-compose exec app ./manage.py populate_first_ready --debug```
|
||||||
|
|
||||||
|
##### Optional parameters
|
||||||
|
| | Parameter | Description |
|
||||||
|
|:-:|:-------------------------- |:----------------------------------------------------------------------------|
|
||||||
|
| 1 | **debug** | Increases logging detail. Defaults to False. |
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue