Skip to content

Commit cb4e4be

Browse files
authored
Merge pull request #62 from x2ansible/automated/x2a-convertor-docs-sync
chore: sync generated docs from x2a-convertor
2 parents 132de59 + 1b05baa commit cb4e4be

3 files changed

Lines changed: 28 additions & 6 deletions

File tree

docs/convertor-reference/cli-reference.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Options:
3737
Commands:
3838
adversarial-run Run adversarial validation agents for a workflow phase.
3939
analyze Perform detailed analysis and create module migration...
40+
health-check Check connectivity to the configured model and AAP.
4041
init Initialize project with interactive message
4142
migrate Migrate project based on migration plan from analysis
4243
publish-aap Sync a git repository to Ansible Automation Platform.
@@ -119,6 +120,27 @@ Options:
119120
--help Show this message and exit.
120121
```
121122

123+
## health-check
124+
125+
Check connectivity to the configured model and AAP.
126+
127+
### Usage
128+
129+
```bash
130+
uv run app.py health-check [OPTIONS]
131+
```
132+
133+
### Full Help
134+
135+
```
136+
Usage: health-check [OPTIONS]
137+
138+
Check connectivity to the configured model and AAP.
139+
140+
Options:
141+
--help Show this message and exit.
142+
```
143+
122144
## init
123145

124146
Initialize project with interactive message

docs/getting-started/docker-usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This example uses the AWS Bedrock provider. You'll need to configure the followi
2424

2525
- **AWS_REGION**: The AWS region where the model will run
2626
- **AWS_BEARER_TOKEN_BEDROCK**: The API key to connect to the LLM
27-
- **LLM_MODEL**: The model to use (this guide uses `bedrock/anthropic.claude-3-7-sonnet-20250219-v1:0`)
27+
- **LLM_MODEL**: The model to use (this guide uses `bedrock/global.anthropic.claude-sonnet-4-5-20250929-v1:0`)
2828

2929
## Initialization
3030

@@ -33,7 +33,7 @@ The first thing we need to do is create the migration-plan.md file which will be
3333
```bash
3434
podman run --rm -ti \
3535
-v $(pwd)/:/app/source:Z \
36-
-e LLM_MODEL=bedrock/anthropic.claude-3-7-sonnet-20250219-v1:0 \
36+
-e LLM_MODEL=bedrock/global.anthropic.claude-sonnet-4-5-20250929-v1:0 \
3737
-e AWS_REGION=$AWS_REGION \
3838
-e AWS_BEARER_TOKEN_BEDROCK=$AWS_BEARER_TOKEN_BEDROCK \
3939
quay.io/x2ansible/x2a-convertor:latest \
@@ -47,7 +47,7 @@ This will create a **migration-plan.md** with a lot of details.
4747
```bash
4848
podman run --rm -ti \
4949
-v $(pwd)/:/app/source:Z \
50-
-e LLM_MODEL=bedrock/anthropic.claude-3-7-sonnet-20250219-v1:0 \
50+
-e LLM_MODEL=bedrock/global.anthropic.claude-sonnet-4-5-20250929-v1:0 \
5151
-e AWS_REGION=$AWS_REGION \
5252
-e AWS_BEARER_TOKEN_BEDROCK=$AWS_BEARER_TOKEN_BEDROCK \
5353
quay.io/x2ansible/x2a-convertor:latest \
@@ -61,7 +61,7 @@ This will make a blueprint of what the model understands about the migration of
6161
```bash
6262
podman run --rm -ti \
6363
-v $(pwd)/:/app/source:Z \
64-
-e LLM_MODEL=bedrock/anthropic.claude-3-7-sonnet-20250219-v1:0 \
64+
-e LLM_MODEL=bedrock/global.anthropic.claude-sonnet-4-5-20250929-v1:0 \
6565
-e AWS_REGION=$AWS_REGION \
6666
-e AWS_BEARER_TOKEN_BEDROCK=$AWS_BEARER_TOKEN_BEDROCK \
6767
-e AAP_CONTROLLER_URL=$AAP_CONTROLLER_URL \

docs/getting-started/usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ This example uses the AWS Bedrock provider. You'll need to configure the followi
2424

2525
- **AWS_REGION**: The AWS region where the model will run
2626
- **AWS_BEARER_TOKEN_BEDROCK**: The API key to connect to the LLM
27-
- **LLM_MODEL**: The model to use (this guide uses `bedrock/anthropic.claude-3-7-sonnet-20250219-v1:0`)
27+
- **LLM_MODEL**: The model to use (this guide uses `bedrock/global.anthropic.claude-sonnet-4-5-20250929-v1:0`)
2828

2929
Export these variables in your shell before running commands:
3030

3131
```bash
3232
# LLM provider — format: provider/model-name (see Requirements table above)
33-
export LLM_MODEL=bedrock/anthropic.claude-3-7-sonnet-20250219-v1:0
33+
export LLM_MODEL=bedrock/global.anthropic.claude-sonnet-4-5-20250929-v1:0
3434

3535
# AWS Bedrock credentials
3636
export AWS_REGION=your-aws-region

0 commit comments

Comments
 (0)