mirror of
https://github.com/cisagov/manage.get.gov.git
synced 2025-08-04 08:52:16 +02:00
Add some documentation
This commit is contained in:
parent
22450ed964
commit
ac4dbd1a64
2 changed files with 35 additions and 3 deletions
|
@ -524,3 +524,37 @@ Example: `cf ssh getgov-za`
|
|||
| 2 | **debug** | Increases logging detail. Defaults to False. |
|
||||
| 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. |
|
||||
|
||||
|
||||
## Patch Federal Agency Info
|
||||
This section outlines how to use `patch_federal_agency_info.py`
|
||||
|
||||
### Running on sandboxes
|
||||
|
||||
#### Step 1: Grab the latest `current-full.csv` file from the dotgov-data repo
|
||||
Download the csv from [here](https://github.com/cisagov/dotgov-data/blob/main/current-full.csv) and place this file under the `src/migrationdata/` directory.
|
||||
|
||||
#### Step 2: Transfer the `current-full.csv` file to your sandbox
|
||||
[Click here to go to the section about transferring data to sandboxes](#step-1-transfer-data-to-sandboxes)
|
||||
|
||||
#### Step 3: Login to CloudFoundry
|
||||
```cf login -a api.fr.cloud.gov --sso```
|
||||
|
||||
#### Step 4: SSH into your environment
|
||||
```cf ssh getgov-{space}```
|
||||
|
||||
Example: `cf ssh getgov-za`
|
||||
|
||||
#### Step 5: Create a shell instance
|
||||
```/tmp/lifecycle/shell```
|
||||
|
||||
#### Step 6: Patch agency info
|
||||
```./manage.py patch_federal_agency_info migrationdata/current-full.csv --debug```
|
||||
|
||||
### Running locally
|
||||
```docker-compose exec app ./manage.py patch_federal_agency_info migrationdata/current-full.csv --debug```
|
||||
|
||||
##### Optional parameters
|
||||
| | Parameter | Description |
|
||||
|:-:|:-------------------------- |:----------------------------------------------------------------------------|
|
||||
| 1 | **debug** | Increases logging detail. Defaults to False. |
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue