Skip to content

use new dropshot tag config to enumerate tags #751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 11, 2022
Merged

use new dropshot tag config to enumerate tags #751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afbef5b
use new dropshot tag config to enumerate tags
ahl Mar 10, 2022
01dcea7
fix openapi test
ahl Mar 10, 2022
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
4 changes: 2 additions & 2 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 19 additions & 2 deletions nexus/src/external_api/http_entrypoints.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,23 @@ use super::{
views::{Organization, Project, Rack, Role, Sled, User, Vpc, VpcSubnet},
};
use crate::context::OpContext;
use dropshot::endpoint;
use dropshot::ApiDescription;
use dropshot::EmptyScanParams;
use dropshot::HttpError;
use dropshot::HttpResponseAccepted;
use dropshot::HttpResponseCreated;
use dropshot::HttpResponseDeleted;
use dropshot::HttpResponseOk;
use dropshot::HttpResponseUpdatedNoContent;
use dropshot::PaginationOrder;
use dropshot::PaginationParams;
use dropshot::Path;
use dropshot::Query;
use dropshot::RequestContext;
use dropshot::ResultsPage;
use dropshot::TypedBody;
use dropshot::WhichPage;
use dropshot::{endpoint, EmptyScanParams, PaginationOrder, PaginationParams};
use omicron_common::api::external::http_pagination::data_page_params_for;
use omicron_common::api::external::http_pagination::data_page_params_nameid_id;
use omicron_common::api::external::http_pagination::data_page_params_nameid_name;
Expand Down Expand Up @@ -158,7 +161,9 @@ pub fn external_api() -> NexusApiDescription {
Ok(())
}

let mut api = NexusApiDescription::new();
let conf = serde_json::from_str(include_str!("./tag-config.json")).unwrap();
let mut api = NexusApiDescription::new().tag_config(conf);

if let Err(err) = register_endpoints(&mut api) {
panic!("failed to register entrypoints: {}", err);
}
Expand Down Expand Up @@ -2281,3 +2286,15 @@ async fn roles_get_role(
};
apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
}

#[cfg(test)]
mod test {
use super::external_api;

#[test]
fn test_nexus_tag_policy() {
// This will fail if any of the endpoints don't match the policy in
// ./tag-config.json
let _ = external_api();
}
}
108 changes: 108 additions & 0 deletions nexus/src/external_api/tag-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
{
"allow_other_tags": false,
"endpoint_tag_policy": "ExactlyOne",
"tag_definitions": {
"disks": {
"description": "Virtual disks are used to store instance-local data which includes the operating system.",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"firewall": {
"description": "Firewall operation controls the flow of network data into a VPC",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"hidden": {
"description": "TODO operations that will not ship to customers",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"instances": {
"description": "Virtual machine instances are the basic unit of computation. These operations are used for provisioning, controlling, and destroying instances.",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"metrics": {
"description": "Metrics provide insight into the operation of the Oxide deployment. These include telemetry on hardware and software components that can be used to understand the current state as well as to diagnose issues.",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"organizations": {
"description": "Organizations represent a subset of users and projects in an Oxide deployment.",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"projects": {
"description": "Projects are a grouping of associated resources such as instances and disks within an organization for purposes of billing and access control.",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"racks": {
"description": "These operations pertain to hardware inventory and management. Racks are the unit of expansion of an Oxide deployment. Racks are in turn composed of sleds, switches, power supplies, and a cabled backplane.",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"roles": {
"description": "Roles are a component of Identity and Access Management (IAM) that allow a user or agent account access to additional permissions.",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"routers": {
"description": "Routers direct the flow of network traffic into, out of, and within a VPC via routes.",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"routes": {
"description": "Routes define router policy.",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"sagas": {
"description": "Sagas are the abstraction used to represent multi-step operations within the Oxide deployment. These operations can be used to query saga status and report errors.",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"sleds": {
"description": "This tag should be moved into hardware",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"subnets": {
"description": "This tag should be moved into a generic network tag",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"updates": {
"description": "This tag should be moved into a operations tag",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"users": {
"description": "This tag should be moved into an IAM tag",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
"vpcs": {
"description": "A Virtual Private Cloud (VPC) is an isolated network environment that should probaby be moved into a more generic networking tag",
"external_docs": {
"url": "http://oxide.computer/docs/#xxx"
}
}
}
}
123 changes: 122 additions & 1 deletion openapi/nexus.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6085,5 +6085,126 @@
]
}
}
}
},
"tags": [
{
"name": "disks",
"description": "Virtual disks are used to store instance-local data which includes the operating system.",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "firewall",
"description": "Firewall operation controls the flow of network data into a VPC",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "hidden",
"description": "TODO operations that will not ship to customers",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
Copy link
Contributor

@jessfraz jessfraz Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are "https://docs.oxide.computer/api/{lowercase tag name}" if you want to fill them in with the real url

Copy link
Contributor

@jessfraz jessfraz Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But I don't technnically need that right now anyways but just so you know

Copy link
Contributor Author

@ahl ahl Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These aren't links to the API documentation; they're links to the product documentation.

Copy link
Contributor

@jessfraz jessfraz Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ha, I see, like a tutorial? https://docs.oxide.computer/tutorials/{thing} ?

Copy link
Contributor

@jessfraz jessfraz Mar 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or the thing in the rack? regardless I guess it doesn't really matter

Copy link
Contributor Author

@ahl ahl Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, like that. e.g. https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instances-and-amis.html

Copy link
Contributor

@jessfraz jessfraz Mar 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah gotcha!

}
},
{
"name": "instances",
"description": "Virtual machine instances are the basic unit of computation. These operations are used for provisioning, controlling, and destroying instances.",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "metrics",
"description": "Metrics provide insight into the operation of the Oxide deployment. These include telemetry on hardware and software components that can be used to understand the current state as well as to diagnose issues.",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "organizations",
"description": "Organizations represent a subset of users and projects in an Oxide deployment.",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "projects",
"description": "Projects are a grouping of associated resources such as instances and disks within an organization for purposes of billing and access control.",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "racks",
"description": "These operations pertain to hardware inventory and management. Racks are the unit of expansion of an Oxide deployment. Racks are in turn composed of sleds, switches, power supplies, and a cabled backplane.",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "roles",
"description": "Roles are a component of Identity and Access Management (IAM) that allow a user or agent account access to additional permissions.",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "routers",
"description": "Routers direct the flow of network traffic into, out of, and within a VPC via routes.",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "routes",
"description": "Routes define router policy.",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "sagas",
"description": "Sagas are the abstraction used to represent multi-step operations within the Oxide deployment. These operations can be used to query saga status and report errors.",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "sleds",
"description": "This tag should be moved into hardware",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "subnets",
"description": "This tag should be moved into a generic network tag",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "updates",
"description": "This tag should be moved into a operations tag",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "users",
"description": "This tag should be moved into an IAM tag",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
},
{
"name": "vpcs",
"description": "A Virtual Private Cloud (VPC) is an isolated network environment that should probaby be moved into a more generic networking tag",
"externalDocs": {
"url": "http://oxide.computer/docs/#xxx"
}
}
]
}