jlengrand/moderne-docs
1
0
Fork 0
mirror of https://github.com/jlengrand/moderne-docs.git synced 2026-03-10 08:31:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: update DX docs show that they can run Devcenter on newer versions of the CLI

Browse Source
This commit is contained in:
leanne
2025-04-11 11:14:20 -07:00
parent aa65b23ab4
commit 1fca48715a
3 changed files with 66 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/administrator-documentation/moderne-dx/how-to-guides/configure-dx-organizations.md
View File

@@ -83,6 +83,7 @@ The following table contains all of the variables/arguments you need to add to y
|---------------------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `MODERNE_DX_ORGANIZATION_URL` | `true` | | The URL of your GraphQL service that provides organization information. Cannot be combined with `MODERNE_DX_ORGANIZATION_REPOSCSV`. |
| `MODERNE_DX_ORGANIZATION_REPOSCSV` | `true` | | The path of your repos.csv file that provides organization information. Cannot be combined with `MODERNE_DX_ORGANIZATION_URL`. |
| `MODERNE_DX_ORGANIZATION_DEVCENTERJSON` | `false` | | The path of your devcenter.json file that provides the devCenter configurations. |
| `MODERNE_DX_ORGANIZATION_DEFAULTCOMMITOPTIONS` | `false` | | The commit options used if not specified by the organization service. |
| `MODERNE_DX_ORGANIZATION_UPDATE_INTERVAL_SECONDS` | `false` | `600` | Specifies how often to request your organization information. Only used when combined with `MODERNE_DX_ORGANIZATION_URL`. |
| `MODERNE_DX_ORGANIZATION_SKIPSSL` | `false` | `false` | Specifies whether or not to skip SSL validation for HTTP connections to this Organization service instance. Only used when combined with `MODERNE_DX_ORGANIZATION_URL`. This must be set to `true` if you use a self-signed SSL/TLS certificate. |
@@ -104,9 +105,10 @@ docker run \
**Arguments:**
| Argument Name | Required | Default | Description |
|---------------------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--moderne.dx.organization.url` | `true` | | The URL of your GraphQL service that provides organization information. Cannot be combined with `MODERNE_DX_ORGANIZATION_REPOSCSV`. |
| `--moderne.dx.organization.reposCsv` | `true` | | The path of your repos.csv file that provides organization information. Cannot be combined with `MODERNE_DX_ORGANIZATION_URL`. |
|---------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--moderne.dx.organization.url` | `true` | | The URL of your GraphQL service that provides organization information. Cannot be combined with `--moderne.dx.organization.reposCsv`. |
| `--moderne.dx.organization.reposCsv` | `true` | | The path of your repos.csv file that provides organization information. Cannot be combined with `--moderne.dx.organization.url`. |
| `--moderne.dx.organization.devCenterJson` | `true` | | The path of your devcenter.json file that provides the devCenter configurations. |
| `--moderne.dx.organization.defaultCommitOptions` | `false` | | The commit options used if not specified by the organization service. |
| `--moderne.dx.organization.updateIntervalSeconds` | `false` | `600` | Specifies how often to request your organization information. Only used when combined with `--moderne.dx.organization.url`. |
| `--moderne.dx.organization.skipSsl` | `false` | `false` | Specifies whether or not to skip SSL validation for HTTP connections to this Organization service instance. Only used when combined with `--moderne.dx.organization.url`. This must be set to `true` if you use a self-signed SSL/TLS certificate. |

8
docs/administrator-documentation/moderne-dx/how-to-guides/dx-variables.md
View File

@@ -272,6 +272,7 @@ java -jar moderne-dx-{version}.jar \
|---------------------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `MODERNE_DX_ORGANIZATION_URL` | `true` | | The URL of your GraphQL service that provides organization information. Cannot be combined with `MODERNE_DX_ORGANIZATION_REPOSCSV`. |
| `MODERNE_DX_ORGANIZATION_REPOSCSV` | `true` | | The path of your repos.csv file that provides organization information. Cannot be combined with `MODERNE_DX_ORGANIZATION_URL`. |
| `MODERNE_DX_ORGANIZATION_DEVCENTERJSON` | `false` | | The path of your devcenter.json file that provides the devCenter configurations. |
| `MODERNE_DX_ORGANIZATION_DEFAULTCOMMITOPTIONS` | `false` | | The commit options used if not specified by the organization service. |
| `MODERNE_DX_ORGANIZATION_UPDATE_INTERVAL_SECONDS` | `false` | `600` | Specifies how often to request your organization information. Only used when combined with `MODERNE_DX_ORGANIZATION_URL`. |
| `MODERNE_DX_ORGANIZATION_SKIPSSL` | `false` | `false` | Specifies whether or not to skip SSL validation for HTTP connections to this Organization service instance. Only used when combined with `MODERNE_DX_ORGANIZATION_URL`. This must be set to `true` if you use a self-signed SSL/TLS certificate. |
@@ -293,9 +294,10 @@ docker run \
**Arguments:**
| Argument Name | Required | Default | Description |
|---------------------------------------------------|----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--moderne.dx.organization.url` | `true` | | The URL of your GraphQL service that provides organization information. Cannot be combined with `MODERNE_DX_ORGANIZATION_REPOSCSV`. |
| `--moderne.dx.organization.reposCsv` | `true` | | The path of your repos.csv file that provides organization information. Cannot be combined with `MODERNE_DX_ORGANIZATION_URL`. |
|---------------------------------------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--moderne.dx.organization.url` | `true` | | The URL of your GraphQL service that provides organization information. Cannot be combined with `--moderne.dx.organization.url`. |
| `--moderne.dx.organization.reposCsv` | `true` | | The path of your repos.csv file that provides organization information. Cannot be combined with `--moderne.dx.organization.reposCsv`. |
| `--moderne.dx.organization.devCenterJson` | `false` | | The path of your devcenter.json file that provides the devCenter configurations. |
| `--moderne.dx.organization.defaultCommitOptions` | `false` | | The commit options used if not specified by the organization service. |
| `--moderne.dx.organization.updateIntervalSeconds` | `false` | `600` | Specifies how often to request your organization information. Only used when combined with `--moderne.dx.organization.url`. |
| `--moderne.dx.organization.skipSsl` | `false` | `false` | Specifies whether or not to skip SSL validation for HTTP connections to this Organization service instance. Only used when combined with `--moderne.dx.organization.url`. This must be set to `true` if you use a self-signed SSL/TLS certificate. |

53
docs/administrator-documentation/moderne-platform/how-to-guides/dev-center.md
View File

@@ -279,9 +279,12 @@ This `devcenter.json` file must follow [the GraphQL schema included in our moder
When creating a DevCenter for the first time, we **strongly recommend** that you only create a DevCenter for a few key organizations. This will allow you to get data into the platform faster and ensure that you've configured everything correctly. Once everything is working as expected, you can then add more DevCenters as desired.
:::
### Step 2: Configure your agent
### Step 2: Configure your agent or DX
Now that you have you a `devcenter.json` file, please place this file in a location were you agent has access to. Next, please direct your agent to said `devcenter.json` file by providing the argument shown below:
Now that you have you a `devcenter.json` file, please place this file in a location were you agent or DX has access to. Next, please direct your agent to said `devcenter.json` file by providing the argument shown below:
<Tabs groupId="source">
<TabItem value="agent" label="Agent">
<Tabs groupId="agent-type">
<TabItem value="oci-container" label="OCI Container">
@@ -322,8 +325,52 @@ java -jar moderne-agent-{version}.jar \
</TabItem>
</Tabs>
</TabItem>
<TabItem value="dx" label="DX">
After you have updated your agent configuration, please restart your agent.
<Tabs groupId="type">
<TabItem value="oci-container" label="OCI Container">
**Variables:**
| Argument Name | Required | Description |
|-----------------------------------------|----------|---------------------------------------------------------------------------------------|
| `MODERNE_DX_ORGANIZATION_DEVCENTERJSON` | `false` | The file path to a JSON file which outlines the DevCenter for specific organizations. |
**Example:**
```bash
docker run \
# ... Existing variables
-e MODERNE_DX_ORGANIZATION_DEVCENTERJSON=/Users/MY_USER/Documents/repos.csv \
# ... Additional variables
```
</TabItem>
<TabItem value="executable-jar" label="Executable JAR">
**Arguments:**
| Argument Name | Required | Description |
|---------------------------------------------|---------------------------------------------------------------------------------------|-------------|
| `--moderne.dx.organization.devCenterJsonse` | The file path to a JSON file which outlines the DevCenter for specific organizations. |
**Example:**
```bash
java -jar moderne-dx-{version}.jar \
# ... Existing arguments
--moderne.dx.organization.devCenterJson=/Users/MY_USER/Documents/repos.csv \
# ... Additional arguments
```
</TabItem>
</Tabs>
</TabItem>
</Tabs>
After you have updated your agent configuration, please restart your agent or DX.
## Configuring the DevCenter in an Organizations service