diff --git a/docs/administrator-documentation/moderne-dx/how-to-guides/configure-dx-organizations.md b/docs/administrator-documentation/moderne-dx/how-to-guides/configure-dx-organizations.md index 0326e9de..d01fd58c 100644 --- a/docs/administrator-documentation/moderne-dx/how-to-guides/configure-dx-organizations.md +++ b/docs/administrator-documentation/moderne-dx/how-to-guides/configure-dx-organizations.md @@ -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. | @@ -103,13 +104,14 @@ 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.defaultCommitOptions` | `false` | | The commit options used if not specified by the organization service. | +| 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.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. | +| `--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. | **Example:** diff --git a/docs/administrator-documentation/moderne-dx/how-to-guides/dx-variables.md b/docs/administrator-documentation/moderne-dx/how-to-guides/dx-variables.md index 4fc56555..be87183b 100644 --- a/docs/administrator-documentation/moderne-dx/how-to-guides/dx-variables.md +++ b/docs/administrator-documentation/moderne-dx/how-to-guides/dx-variables.md @@ -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. | @@ -292,13 +293,14 @@ 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.defaultCommitOptions` | `false` | | The commit options used if not specified by the organization service. | +| 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.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. | +| `--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. | **Example:** diff --git a/docs/administrator-documentation/moderne-platform/how-to-guides/dev-center.md b/docs/administrator-documentation/moderne-platform/how-to-guides/dev-center.md index b6ccc49e..68680591 100644 --- a/docs/administrator-documentation/moderne-platform/how-to-guides/dev-center.md +++ b/docs/administrator-documentation/moderne-platform/how-to-guides/dev-center.md @@ -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 your agent or DX has access to. Next, please direct your agent to said `devcenter.json` file by providing the argument shown below: + + + @@ -322,8 +325,52 @@ java -jar moderne-agent-{version}.jar \ + + -After you have updated your agent configuration, please restart your agent. + + + +**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 +``` + + + + + +**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 +``` + + + + + + +After you have updated your agent configuration, please restart your agent or DX. ## Configuring the DevCenter in an Organizations service