Skip to content

Commit

Permalink
Replace all instances of example.com with example.interuss.org (#741)
Browse files Browse the repository at this point in the history 
* Replace example.com with example.interuss.org in all python scripts

* Replace example.com with example.interuss.com in all yaml

* Replace example.com with example.interuss.com in all json

* Replace example.com with example.interuss.com in all markdown

* Format files according to 'make format'
  • Loading branch information
@brandoncorrea
brandoncorrea authored Aug 5, 2024
1 parent 613d1a6 commit cac1298
Show file tree
Hide file tree
Showing 41 changed files with 125 additions and 107 deletions.
2 changes: 1 addition & 1 deletion interfaces/dummy-oauth/dummy-oauth.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ paths:
description: Fully-qualified domain name where the service for which this access token will be used is hosted. The `aud` claim will be populated with this value.
schema:
type: string
example: uss.example.com
example: uss.example.interuss.org
- name: scope
in: query
required: true
Expand Down
2 changes: 1 addition & 1 deletion interfaces/rid/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## Mixing versions in a single ecosystem

If all USSs in an ecosystem use the v1 API, then everything is fine. If all USSs in an ecosystem use the v2 API, then everything is fine. If some USSs in an ecosystem use v1 while others use v2, there may be interoperability problems. To avoid accidentally missing ISAs, this DSS implementation stores v1 and v2 ISAs alongside each other. The URL field for v1 ISAs contains the `/flights` resource URL (e.g., `https://example.com/v1/uss/flights`), but this same URL field contains the base URL (e.g., `http://example.com/rid/v2`) for v2 ISAs. This means a v1 USS may try to query `http://example.com/rid/v2` if reading a v2 USS's ISA, or a v2 USS may try to query `http://example.com/v1/uss/flights/uss/flights` if reading a v1 USS's ISA. This issue is somewhat intentional because even though v1 and v2 both have a `/flights` endpoint, the communications protocol for these two endpoints is not compatible. If v1 and v2 ISAs are going to co-exist in the same ecosystem, then every USS in that ecosystem must infer the USS-USS communications protocol based on the content of the URL field (`flights_url` and `identification_service_area_url` in v1 and `uss_base_url` in v2).
If all USSs in an ecosystem use the v1 API, then everything is fine. If all USSs in an ecosystem use the v2 API, then everything is fine. If some USSs in an ecosystem use v1 while others use v2, there may be interoperability problems. To avoid accidentally missing ISAs, this DSS implementation stores v1 and v2 ISAs alongside each other. The URL field for v1 ISAs contains the `/flights` resource URL (e.g., `https://example.interuss.org/v1/uss/flights`), but this same URL field contains the base URL (e.g., `http://example.interuss.org/rid/v2`) for v2 ISAs. This means a v1 USS may try to query `http://example.interuss.org/rid/v2` if reading a v2 USS's ISA, or a v2 USS may try to query `http://example.interuss.org/v1/uss/flights/uss/flights` if reading a v1 USS's ISA. This issue is somewhat intentional because even though v1 and v2 both have a `/flights` endpoint, the communications protocol for these two endpoints is not compatible. If v1 and v2 ISAs are going to co-exist in the same ecosystem, then every USS in that ecosystem must infer the USS-USS communications protocol based on the content of the URL field (`flights_url` and `identification_service_area_url` in v1 and `uss_base_url` in v2).

### v1 ISAs

Expand Down
4 changes: 2 additions & 2 deletions monitoring/loadtest/locust_files/ISA.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def create_isa(self):
"time_start": time_start.strftime(rid_v1.DATE_FORMAT),
"time_end": time_end.strftime(rid_v1.DATE_FORMAT),
},
"flights_url": "https://example.com/dss",
"flights_url": "https://example.interuss.org/dss",
},
)
if resp.status_code == 200:
Expand Down Expand Up @@ -63,7 +63,7 @@ def update_isa(self):
"time_start": time_start.strftime(rid_v1.DATE_FORMAT),
"time_end": time_end.strftime(rid_v1.DATE_FORMAT),
},
"flights_url": "https://example.com/dss",
"flights_url": "https://example.interuss.org/dss",
},
)
if resp.status_code == 200:
Expand Down
4 changes: 2 additions & 2 deletions monitoring/loadtest/locust_files/Sub.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def create_sub(self):
"time_end": time_end.strftime(rid_v1.DATE_FORMAT),
},
"callbacks": {
"identification_service_area_url": "https://example.com/foo"
"identification_service_area_url": "https://example.interuss.org/foo"
},
},
)
Expand Down Expand Up @@ -84,7 +84,7 @@ def update_sub(self):
"time_end": time_end.strftime(rid_v1.DATE_FORMAT),
},
"callbacks": {
"identification_service_area_url": "https://example.com/foo"
"identification_service_area_url": "https://example.interuss.org/foo"
},
},
)
Expand Down
2 changes: 1 addition & 1 deletion monitoring/mock_uss/deployment/gcp/kubernetes-deployment.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ kubectl apply -f mockuss.yaml

GKE ingresses with managed certificates can take tens of minutes to provision; track progress in the Ingresses tab of the Services GKE menu item.

Confirm deployment by visiting https://your-domain.example.com/status in a browser, which should display the version.
Confirm deployment by visiting https://your-domain.example.interuss.org/status in a browser, which should display the version.
12 changes: 6 additions & 6 deletions monitoring/mock_uss/deployment/gcp/mockuss.example.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ spec:
readOnly: true
env:
- name: MOCK_USS_DSS_URL
value: https://dss.example.com <-- UPDATE
value: https://dss.example.interuss.org <-- UPDATE
- name: MOCK_USS_PUBLIC_KEY
value: https://auth.example.com/jwks.json <-- UPDATE
value: https://auth.example.interuss.org/jwks.json <-- UPDATE
- name: MOCK_USS_TOKEN_AUDIENCE
value: mockuss.example.com <-- UPDATE
value: mockuss.example.interuss.org <-- UPDATE
- name: MOCK_USS_BASE_URL
value: https://mockuss.example.com <-- UPDATE
value: https://mockuss.example.interuss.org <-- UPDATE
- name: MOCK_USS_SERVICES
value: scdsc,versioning,interaction_logging,flight_planning
- name: MOCK_USS_INTERACTIONS_LOG_DIR
value: /output/interaction_logs
- name: MOCK_USS_PORT
value: "8074"
- name: MOCK_USS_AUTH_SPEC
value: ServiceAccount(https://auth.example.com/oauth/token,/auth/mock_uss-creds.json) <-- UPDATE
value: ServiceAccount(https://auth.example.interuss.org/oauth/token,/auth/mock_uss-creds.json) <-- UPDATE
command: ["/bin/sh", "-c"]
args:
- mkdir -p /output/interaction_logs && mock_uss/start.sh
Expand Down Expand Up @@ -66,7 +66,7 @@ metadata:
name: managed-cert
spec:
domains:
- mockuss.example.com <-- UPDATE
- mockuss.example.interuss.org <-- UPDATE

---
apiVersion: networking.k8s.io/v1
Expand Down
6 changes: 3 additions & 3 deletions monitoring/mock_uss/postman_collection.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"requested_flights\": [\n {\n \"injection_id\": \"edb7695f-8737-4b9f-91f8-e2afbb333f41\",\n \"telemetry\": [\n {\n \"timestamp\": \"{{t_1}}\",\n \"timestamp_accuracy\": 5,\n \"operational_status\": \"Airborne\",\n \"position\": {\n \"lat\": 34.1231,\n \"lng\": -118.4561,\n \"alt\": 1321.1,\n \"accuracy_h\": \"HA3m\",\n \"accuracy_v\": \"VA10m\",\n \"extrapolated\": false\n },\n \"track\": 90,\n \"speed\": 1.9,\n \"speed_accuracy\": \"SA10mpsPlus\",\n \"vertical_speed\": 0\n },\n {\n \"timestamp\": \"{{t_2}}\",\n \"timestamp_accuracy\": 5,\n \"operational_status\": \"Airborne\",\n \"position\": {\n \"lat\": 34.1231,\n \"lng\": -118.4551,\n \"alt\": 1321.1,\n \"accuracy_h\": \"HA3m\",\n \"accuracy_v\": \"VA10m\",\n \"extrapolated\": false\n },\n \"track\": 180,\n \"speed\": 2.0,\n \"speed_accuracy\": \"SA10mpsPlus\",\n \"vertical_speed\": 0\n },\n {\n \"timestamp\": \"{{t_3}}\",\n \"timestamp_accuracy\": 5,\n \"operational_status\": \"Airborne\",\n \"position\": {\n \"lat\": 34.1221,\n \"lng\": -118.4551,\n \"alt\": 1321.1,\n \"accuracy_h\": \"HA3m\",\n \"accuracy_v\": \"VA10m\",\n \"extrapolated\": false\n },\n \"track\": 270,\n \"speed\": 2.1,\n \"speed_accuracy\": \"SA10mpsPlus\",\n \"vertical_speed\": 0\n },\n {\n \"timestamp\": \"{{t_4}}\",\n \"timestamp_accuracy\": 5,\n \"operational_status\": \"Airborne\",\n \"position\": {\n \"lat\": 34.1221,\n \"lng\": -118.4561,\n \"alt\": 1321.1,\n \"accuracy_h\": \"HA3m\",\n \"accuracy_v\": \"VA10m\",\n \"extrapolated\": false\n },\n \"track\": 270,\n \"speed\": 2.2,\n \"speed_accuracy\": \"SA10mpsPlus\",\n \"vertical_speed\": 0\n },\n {\n \"timestamp\": \"{{t_5}}\",\n \"timestamp_accuracy\": 5,\n \"operational_status\": \"Airborne\",\n \"position\": {\n \"lat\": 34.1221,\n \"lng\": -118.4571,\n \"alt\": 1321.1,\n \"accuracy_h\": \"HA3m\",\n \"accuracy_v\": \"VA10m\",\n \"extrapolated\": false\n },\n \"track\": 45,\n \"speed\": 2.3,\n \"speed_accuracy\": \"SA10mpsPlus\",\n \"vertical_speed\": 0\n }\n ],\n \"details_responses\": [\n {\n \"effective_after\": \"{{t_1}}\",\n \"details\": {\n \"id\": \"a3423b-213401-0023\",\n \"operator_id\": \"operator1\",\n \"operator_location\": {\n \"lng\": -118.4561,\n \"lat\": 34.1231\n },\n \"operation_description\": \"SafeFlightDrone company doing survey with DJI Inspire 2. See my privacy policy www.example.com/privacy.\",\n \"serial_number\": \"INTCJ123-4567-891\",\n \"registration_number\": \"FA12345891\"\n }\n }\n ]\n }\n ]\n}",
"raw": "{\n \"requested_flights\": [\n {\n \"injection_id\": \"edb7695f-8737-4b9f-91f8-e2afbb333f41\",\n \"telemetry\": [\n {\n \"timestamp\": \"{{t_1}}\",\n \"timestamp_accuracy\": 5,\n \"operational_status\": \"Airborne\",\n \"position\": {\n \"lat\": 34.1231,\n \"lng\": -118.4561,\n \"alt\": 1321.1,\n \"accuracy_h\": \"HA3m\",\n \"accuracy_v\": \"VA10m\",\n \"extrapolated\": false\n },\n \"track\": 90,\n \"speed\": 1.9,\n \"speed_accuracy\": \"SA10mpsPlus\",\n \"vertical_speed\": 0\n },\n {\n \"timestamp\": \"{{t_2}}\",\n \"timestamp_accuracy\": 5,\n \"operational_status\": \"Airborne\",\n \"position\": {\n \"lat\": 34.1231,\n \"lng\": -118.4551,\n \"alt\": 1321.1,\n \"accuracy_h\": \"HA3m\",\n \"accuracy_v\": \"VA10m\",\n \"extrapolated\": false\n },\n \"track\": 180,\n \"speed\": 2.0,\n \"speed_accuracy\": \"SA10mpsPlus\",\n \"vertical_speed\": 0\n },\n {\n \"timestamp\": \"{{t_3}}\",\n \"timestamp_accuracy\": 5,\n \"operational_status\": \"Airborne\",\n \"position\": {\n \"lat\": 34.1221,\n \"lng\": -118.4551,\n \"alt\": 1321.1,\n \"accuracy_h\": \"HA3m\",\n \"accuracy_v\": \"VA10m\",\n \"extrapolated\": false\n },\n \"track\": 270,\n \"speed\": 2.1,\n \"speed_accuracy\": \"SA10mpsPlus\",\n \"vertical_speed\": 0\n },\n {\n \"timestamp\": \"{{t_4}}\",\n \"timestamp_accuracy\": 5,\n \"operational_status\": \"Airborne\",\n \"position\": {\n \"lat\": 34.1221,\n \"lng\": -118.4561,\n \"alt\": 1321.1,\n \"accuracy_h\": \"HA3m\",\n \"accuracy_v\": \"VA10m\",\n \"extrapolated\": false\n },\n \"track\": 270,\n \"speed\": 2.2,\n \"speed_accuracy\": \"SA10mpsPlus\",\n \"vertical_speed\": 0\n },\n {\n \"timestamp\": \"{{t_5}}\",\n \"timestamp_accuracy\": 5,\n \"operational_status\": \"Airborne\",\n \"position\": {\n \"lat\": 34.1221,\n \"lng\": -118.4571,\n \"alt\": 1321.1,\n \"accuracy_h\": \"HA3m\",\n \"accuracy_v\": \"VA10m\",\n \"extrapolated\": false\n },\n \"track\": 45,\n \"speed\": 2.3,\n \"speed_accuracy\": \"SA10mpsPlus\",\n \"vertical_speed\": 0\n }\n ],\n \"details_responses\": [\n {\n \"effective_after\": \"{{t_1}}\",\n \"details\": {\n \"id\": \"a3423b-213401-0023\",\n \"operator_id\": \"operator1\",\n \"operator_location\": {\n \"lng\": -118.4561,\n \"lat\": 34.1231\n },\n \"operation_description\": \"SafeFlightDrone company doing survey with DJI Inspire 2. See my privacy policy example.interuss.org/privacy.\",\n \"serial_number\": \"INTCJ123-4567-891\",\n \"registration_number\": \"FA12345891\"\n }\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
Expand Down Expand Up @@ -613,7 +613,7 @@
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"operational_intent\": {\n \"state\": \"Accepted\",\n \"priority\": 0,\n \"volumes\": [\n {\n \"volume\": {\n \"outline_polygon\": {\n \"vertices\": [\n {\n \"lng\": -155.6043,\n \"lat\": 19.4763\n },\n {\n \"lng\": -155.5746,\n \"lat\": 19.4884\n },\n {\n \"lng\": -155.5941,\n \"lat\": 19.4516\n }\n ]\n },\n \"altitude_lower\": {\n \"value\": 0,\n \"units\": \"M\",\n \"reference\": \"W84\"\n },\n \"altitude_upper\": {\n \"value\": 122,\n \"units\": \"M\",\n \"reference\": \"W84\"\n }\n },\n \"time_start\": {\n \"value\": \"{{timestamp_start}}\",\n \"format\": \"RFC3339\"\n },\n \"time_end\": {\n \"value\": \"{{timestamp_end}}\",\n \"format\": \"RFC3339\"\n }\n }\n ],\n \"off_nominal_volumes\": []\n },\n \"flight_authorisation\": {\n \"uas_serial_number\": \"TBPADUZCSXBFMTKAUV\",\n \"operation_category\": \"Open\",\n \"operation_mode\": \"Vlos\",\n \"uas_class\": \"C0\",\n \"identification_technologies\": [\n \"ASTMNetRID\"\n ],\n \"connectivity_methods\": [\n \"cellular\"\n ],\n \"endurance_minutes\": 30,\n \"emergency_procedure_url\": \"https://example.com/emergency\",\n \"operator_id\": \"CHEa34mqjq4jshtf-cyn\"\n }\n}",
"raw": "{\n \"operational_intent\": {\n \"state\": \"Accepted\",\n \"priority\": 0,\n \"volumes\": [\n {\n \"volume\": {\n \"outline_polygon\": {\n \"vertices\": [\n {\n \"lng\": -155.6043,\n \"lat\": 19.4763\n },\n {\n \"lng\": -155.5746,\n \"lat\": 19.4884\n },\n {\n \"lng\": -155.5941,\n \"lat\": 19.4516\n }\n ]\n },\n \"altitude_lower\": {\n \"value\": 0,\n \"units\": \"M\",\n \"reference\": \"W84\"\n },\n \"altitude_upper\": {\n \"value\": 122,\n \"units\": \"M\",\n \"reference\": \"W84\"\n }\n },\n \"time_start\": {\n \"value\": \"{{timestamp_start}}\",\n \"format\": \"RFC3339\"\n },\n \"time_end\": {\n \"value\": \"{{timestamp_end}}\",\n \"format\": \"RFC3339\"\n }\n }\n ],\n \"off_nominal_volumes\": []\n },\n \"flight_authorisation\": {\n \"uas_serial_number\": \"TBPADUZCSXBFMTKAUV\",\n \"operation_category\": \"Open\",\n \"operation_mode\": \"Vlos\",\n \"uas_class\": \"C0\",\n \"identification_technologies\": [\n \"ASTMNetRID\"\n ],\n \"connectivity_methods\": [\n \"cellular\"\n ],\n \"endurance_minutes\": 30,\n \"emergency_procedure_url\": \"https://example.interuss.org/emergency\",\n \"operator_id\": \"CHEa34mqjq4jshtf-cyn\"\n }\n}",
"options": {
"raw": {
"language": "json"
Expand Down Expand Up @@ -1145,4 +1145,4 @@
]
}
]
}
}
10 changes: 5 additions & 5 deletions monitoring/monitorlib/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ AuthAdapter's `__init__` constructor. Both ordinal (e.g.,
### Examples

* `NoAuth()`
* `UsernamePassword(https://example.com/token, username=uss1, password=uss1,
* `UsernamePassword(https://example.interuss.org/token, username=uss1, password=uss1,
client_id=uss1)`
* `ServiceAccount(https://example.com/token, ~/credentials/account.json)`
* `FlightPassport(https://example.com/oauth/token/, client_id=NdepxcA, client_secret=PSh7DzZdN)`
* `ServiceAccount(https://example.interuss.org/token, ~/credentials/account.json)`
* `FlightPassport(https://example.interuss.org/oauth/token/, client_id=NdepxcA, client_secret=PSh7DzZdN)`
* `DummyOAuth(http://localhost:8085/token, sub=fake_uss)`
* `SignedRequest(https://example.com/oauth/token, client_id=uss1.com,
* `SignedRequest(https://example.interuss.org/oauth/token, client_id=uss1.com,
key_path=/auth/uss1.key, cert_url=https://uss1.com/uss1.der)`
* `ClientIdClientSecret(https://example.com/token, uss1, dXNzMQ==)`
* `ClientIdClientSecret(https://example.interuss.org/token, uss1, dXNzMQ==)`

### Testing

Expand Down
2 changes: 1 addition & 1 deletion monitoring/prober/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ tokens. See [the auth spec documentation](../monitorlib/README.md#Auth_specs)
for the format of these values. Note that if an authorization spec is omitted,
the tests that depend on that authorization will be skipped.

Example: `--rid-auth "UsernamePassword(https://example.com/token, username=uss1,
Example: `--rid-auth "UsernamePassword(https://example.interuss.org/token, username=uss1,
password=uss1, client_id=uss1)"`

## Running prober via Docker
Expand Down
2 changes: 1 addition & 1 deletion monitoring/prober/rid/v1/test_isa_expiry.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def test_create(ids, session_ridv1):
"time_start": time_start.strftime(rid_v1.DATE_FORMAT),
"time_end": time_end.strftime(rid_v1.DATE_FORMAT),
},
"flights_url": "https://example.com/dss",
"flights_url": "https://example.interuss.org/dss",
},
)
assert resp.status_code == 200, resp.content
Expand Down
Loading

0 comments on commit cac1298

Please sign in to comment.