Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .evergreen/auth_oidc/azure/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and then tearing down the VM and its resources.
There are a set of scripts that facilitate these operations.
They build on top of the scripts used in `csfle/azurekms`.

See [Secrets Handling](../secrets_handling/README.md) for details on how the script accesses the `drivers/azureoidc` vault.
See [Secrets Handling](../../secrets_handling/README.md) for details on how the script accesses the `drivers/azureoidc` vault.
These secrets are used to log in to Azure, and the rest of the secrets are fetched from the "OIDC-Key-Vault" in our Drivers Azure Subscription (https://portal.azure.com/#home).

See the [How-To: Set up Azure OIDC Infrastructure](https://wiki.corp.mongodb.com/display/DRIVERS/How-To%3A+Set+up+Azure+OIDC+Infrastructure) wiki for background on how the infrastructure is set up.
Expand Down
2 changes: 1 addition & 1 deletion .evergreen/auth_oidc/gcp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ and then tearing down the Atlas cluster, and VM and its resources.
There are a set of scripts that facilitate these operations.
They build on top of the scripts used in `csfle/gcpkms`.

See [Secrets Handling](../secrets_handling/README.md) for details on how the script accesses the `drivers/gcpoidc` vault.
See [Secrets Handling](../../secrets_handling/README.md) for details on how the script accesses the `drivers/gcpoidc` vault.

See the [How-To: Set up GCP OIDC Infrastructure](https://wiki.corp.mongodb.com/display/DRIVERS/How-To%3A+Set+up+GCP+OIDC+Infrastructure) wiki for information on how the infrastructure is set up.

Expand Down
4 changes: 2 additions & 2 deletions .evergreen/aws_lambda/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AWS Lamba Testing

See the [FaaS Automated Testing specification](https://github.com/mongodb/specifications/blob/master/source/faas-automated-testing/faas-automated-testing.rst) for details.
See the [FaaS Automated Testing specification](https://github.com/mongodb/specifications/blob/master/source/faas-automated-testing/faas-automated-testing.md) for details.

See [Secrets Handling README](../secrets-handling/README.md) for details on how to access the secrets
See [Secrets Handling README](../secrets_handling/README.md) for details on how to access the secrets
from the `drivers/atlas-qa` vault.
2 changes: 1 addition & 1 deletion .evergreen/csfle/azurekms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ If you need a larger Azure VM, set `AZUREKMS_MACHINESIZE` to a larger [size](htt

# Usage with AWS Vault

See [Secrets Handling](../secrets_handling/README.md) for details on how to access the secrets
See [Secrets Handling](../../secrets_handling/README.md) for details on how to access the secrets
from the `drivers/azurekms` vault.

Your Evergreen config should look something like:
Expand Down
2 changes: 1 addition & 1 deletion .evergreen/csfle/gcpkms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ If you need a larger GCP [VM](https://cloud.google.com/compute/docs/machine-reso

# Usage with AWS Vault

See [Secrets Handling](../secrets_handling/README.md) for details on how to access the secrets
See [Secrets Handling](../../secrets_handling/README.md) for details on how to access the secrets
from the `drivers/gcpkms` vault.

```yaml
Expand Down
2 changes: 1 addition & 1 deletion .evergreen/secrets_handling/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The `setup-secrets.sh` script in this folder can be used for other vaults such a
| drivers/enterprise_auth | Has the creds needed for Enterprise Auth testing. |
| drivers/gcpkms | Used in [`cslfe/gcpkms`](../csfle/gcpkms/README.md) for GCP KMS testing. |
| drivers/gcpoidc | Used in [`auth_oidc/gcp`](../auth_oidc/gcp/README.md) for OIDC Testing on GCP. |
| drivers/oidc | Used in [`oidc`](../oidc/README.md) for OIDC Auth testing. |
| drivers/oidc | Used in [`oidc`](../auth_oidc/README.md) for OIDC Auth testing. |
| drivers/serverless | Used in [`serverless`](../serverless/README.md) for serverless testing. |
| drivers/serverless_next | Used in [`serverless`](../serverless/README.md) for serverless proxy testing. |

Expand Down
33 changes: 33 additions & 0 deletions .github/workflows/markdown.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: "Markdown Check"

on:
pull_request:
branches:
- "master"
push:
branches:
- "master"

concurrency:
group: markdown-${{ github.ref }}
cancel-in-progress: true

jobs:
check-markdown:
name: "Check Markdown Files"
runs-on: ubuntu-latest
timeout-minutes: 5
permissions:
pull-requests: write
contents: read

steps:
- name: "Checkout"
uses: "actions/checkout@v6"

- name: "Check Markdown"
uses: "john0isaac/action-check-markdown@274ad7e69a147c37274e1a94fb01ddb175c57bed"
with:
github-token: ${{secrets.GITHUB_TOKEN}}
command: check_broken_paths
directory: ./
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ returned from the `setup-mongodb` workflow step when running tests:
### Starting and Stopping Servers Locally or on an Evergreen Host

There are two options for running a MongoDB server configuration.
One is to use [docker](./.evergreen/docker/README.md).
One is to use [docker](.evergreen/docker/README.md).
The other is to run `./evergreen/run-orchestration.sh` locally.
For convenience, you can run `make run-server` and `make stop-server` to start and stop the server(s).

Expand All @@ -95,7 +95,7 @@ TOPOLOGY=replica_set MONGODB_VERSION=7.0 make run-server

You can also run: `make run-local-atlas` to run a local atlas server in a container.

See (run-orchestration.sh)[./evergreen/run-orchestration.sh] for the available environment variables.
See [run-orchestration.sh](.evergreen/run-orchestration.sh) for the available environment variables.
Run `bash ./evergreen/run-orchestration.sh --help` for usage of command line flags.

In order to use custom certificates in your server, set the following environment variables:
Expand Down Expand Up @@ -213,12 +213,12 @@ Subfolders that have setup and teardown requirements are encouraged to also prov
`setup-test.sh` and `teardown-test.sh`.

NOTE: The subfolder setup/teardown scripts requires users to have configured
support for [Secrets Handling](./.evergreen/secrets_handling/README.md).
support for [Secrets Handling](.evergreen/secrets_handling/README.md).


## Secrets Handling

See the Secrets Handling [readme](./.evergreen/secrets_handling/README.md) for more information on how secrets are managed
See the Secrets Handling [readme](.evergreen/secrets_handling/README.md) for more information on how secrets are managed
locally and on on Evergreen.

# Python CLIs
Expand Down
Loading