Skip to content

Commit

Permalink
api: freeze v3 API. (envoyproxy#9694)
Browse files Browse the repository at this point in the history
In which we convert every v3alpha reference to v3. In future revs of the
stable API versioning policy, we will develop better tooling to support
> 2 alpha and stable versions. For v3, it seems reasonable to just mv
v3alpha to v3, since there should be no external consumers yet.

Risk level: Low
Testing: bazel test //test/..., CI.

Signed-off-by: Harvey Tuch <[email protected]>
  • Loading branch information
htuch authored Jan 16, 2020
1 parent 7d3c6b2 commit 5248a4f
Show file tree
Hide file tree
Showing 2,219 changed files with 45,777 additions and 46,471 deletions.
196 changes: 98 additions & 98 deletions api/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ proto_library(
visibility = ["//visibility:public"],
deps = [
"//envoy/admin/v2alpha:pkg",
"//envoy/admin/v3alpha:pkg",
"//envoy/admin/v3:pkg",
"//envoy/api/v2:pkg",
"//envoy/api/v2/auth:pkg",
"//envoy/api/v2/cluster:pkg",
Expand All @@ -19,17 +19,17 @@ proto_library(
"//envoy/api/v2/ratelimit:pkg",
"//envoy/api/v2/route:pkg",
"//envoy/config/accesslog/v2:pkg",
"//envoy/config/accesslog/v3alpha:pkg",
"//envoy/config/accesslog/v3:pkg",
"//envoy/config/bootstrap/v2:pkg",
"//envoy/config/bootstrap/v3alpha:pkg",
"//envoy/config/bootstrap/v3:pkg",
"//envoy/config/cluster/aggregate/v2alpha:pkg",
"//envoy/config/cluster/dynamic_forward_proxy/v2alpha:pkg",
"//envoy/config/cluster/redis:pkg",
"//envoy/config/cluster/v3alpha:pkg",
"//envoy/config/cluster/v3:pkg",
"//envoy/config/common/dynamic_forward_proxy/v2alpha:pkg",
"//envoy/config/common/tap/v2alpha:pkg",
"//envoy/config/core/v3alpha:pkg",
"//envoy/config/endpoint/v3alpha:pkg",
"//envoy/config/core/v3:pkg",
"//envoy/config/endpoint/v3:pkg",
"//envoy/config/filter/accesslog/v2:pkg",
"//envoy/config/filter/dubbo/router/v2alpha1:pkg",
"//envoy/config/filter/fault/v2:pkg",
Expand Down Expand Up @@ -84,129 +84,129 @@ proto_library(
"//envoy/config/filter/thrift/router/v2alpha1:pkg",
"//envoy/config/filter/udp/udp_proxy/v2alpha:pkg",
"//envoy/config/grpc_credential/v2alpha:pkg",
"//envoy/config/grpc_credential/v3alpha:pkg",
"//envoy/config/grpc_credential/v3:pkg",
"//envoy/config/health_checker/redis/v2:pkg",
"//envoy/config/listener/v2:pkg",
"//envoy/config/listener/v3alpha:pkg",
"//envoy/config/listener/v3:pkg",
"//envoy/config/metrics/v2:pkg",
"//envoy/config/metrics/v3alpha:pkg",
"//envoy/config/metrics/v3:pkg",
"//envoy/config/overload/v2alpha:pkg",
"//envoy/config/overload/v3alpha:pkg",
"//envoy/config/overload/v3:pkg",
"//envoy/config/ratelimit/v2:pkg",
"//envoy/config/ratelimit/v3alpha:pkg",
"//envoy/config/ratelimit/v3:pkg",
"//envoy/config/rbac/v2:pkg",
"//envoy/config/rbac/v3alpha:pkg",
"//envoy/config/rbac/v3:pkg",
"//envoy/config/resource_monitor/fixed_heap/v2alpha:pkg",
"//envoy/config/resource_monitor/injected_resource/v2alpha:pkg",
"//envoy/config/retry/omit_canary_hosts/v2:pkg",
"//envoy/config/retry/previous_hosts/v2:pkg",
"//envoy/config/retry/previous_priorities:pkg",
"//envoy/config/route/v3alpha:pkg",
"//envoy/config/tap/v3alpha:pkg",
"//envoy/config/route/v3:pkg",
"//envoy/config/tap/v3:pkg",
"//envoy/config/trace/v2:pkg",
"//envoy/config/trace/v2alpha:pkg",
"//envoy/config/trace/v3alpha:pkg",
"//envoy/config/trace/v3:pkg",
"//envoy/config/transport_socket/alts/v2alpha:pkg",
"//envoy/config/transport_socket/raw_buffer/v2:pkg",
"//envoy/config/transport_socket/tap/v2alpha:pkg",
"//envoy/data/accesslog/v2:pkg",
"//envoy/data/accesslog/v3alpha:pkg",
"//envoy/data/accesslog/v3:pkg",
"//envoy/data/cluster/v2alpha:pkg",
"//envoy/data/core/v2alpha:pkg",
"//envoy/data/core/v3alpha:pkg",
"//envoy/data/core/v3:pkg",
"//envoy/data/tap/v2alpha:pkg",
"//envoy/data/tap/v3alpha:pkg",
"//envoy/extensions/access_loggers/file/v3alpha:pkg",
"//envoy/extensions/access_loggers/grpc/v3alpha:pkg",
"//envoy/extensions/clusters/aggregate/v3alpha:pkg",
"//envoy/extensions/clusters/dynamic_forward_proxy/v3alpha:pkg",
"//envoy/extensions/clusters/redis/v3alpha:pkg",
"//envoy/extensions/common/dynamic_forward_proxy/v3alpha:pkg",
"//envoy/extensions/common/ratelimit/v3alpha:pkg",
"//envoy/extensions/common/tap/v3alpha:pkg",
"//envoy/extensions/filters/common/fault/v3alpha:pkg",
"//envoy/extensions/filters/http/adaptive_concurrency/v3alpha:pkg",
"//envoy/extensions/filters/http/buffer/v3alpha:pkg",
"//envoy/extensions/filters/http/cors/v3alpha:pkg",
"//envoy/extensions/filters/http/csrf/v3alpha:pkg",
"//envoy/extensions/filters/http/dynamic_forward_proxy/v3alpha:pkg",
"//envoy/extensions/filters/http/dynamo/v3alpha:pkg",
"//envoy/extensions/filters/http/ext_authz/v3alpha:pkg",
"//envoy/extensions/filters/http/fault/v3alpha:pkg",
"//envoy/extensions/filters/http/grpc_http1_bridge/v3alpha:pkg",
"//envoy/extensions/filters/http/grpc_http1_reverse_bridge/v3alpha:pkg",
"//envoy/extensions/filters/http/grpc_json_transcoder/v3alpha:pkg",
"//envoy/extensions/filters/http/grpc_stats/v3alpha:pkg",
"//envoy/extensions/filters/http/grpc_web/v3alpha:pkg",
"//envoy/extensions/filters/http/gzip/v3alpha:pkg",
"//envoy/extensions/filters/http/header_to_metadata/v3alpha:pkg",
"//envoy/extensions/filters/http/health_check/v3alpha:pkg",
"//envoy/extensions/filters/http/ip_tagging/v3alpha:pkg",
"//envoy/extensions/filters/http/jwt_authn/v3alpha:pkg",
"//envoy/extensions/filters/http/lua/v3alpha:pkg",
"//envoy/extensions/filters/http/on_demand/v3alpha:pkg",
"//envoy/extensions/filters/http/original_src/v3alpha:pkg",
"//envoy/extensions/filters/http/ratelimit/v3alpha:pkg",
"//envoy/extensions/filters/http/rbac/v3alpha:pkg",
"//envoy/extensions/filters/http/router/v3alpha:pkg",
"//envoy/extensions/filters/http/squash/v3alpha:pkg",
"//envoy/extensions/filters/http/tap/v3alpha:pkg",
"//envoy/extensions/filters/listener/http_inspector/v3alpha:pkg",
"//envoy/extensions/filters/listener/original_dst/v3alpha:pkg",
"//envoy/extensions/filters/listener/original_src/v3alpha:pkg",
"//envoy/extensions/filters/listener/proxy_protocol/v3alpha:pkg",
"//envoy/extensions/filters/listener/tls_inspector/v3alpha:pkg",
"//envoy/extensions/filters/network/client_ssl_auth/v3alpha:pkg",
"//envoy/extensions/filters/network/dubbo_proxy/router/v3alpha:pkg",
"//envoy/extensions/filters/network/dubbo_proxy/v3alpha:pkg",
"//envoy/extensions/filters/network/echo/v3alpha:pkg",
"//envoy/extensions/filters/network/ext_authz/v3alpha:pkg",
"//envoy/extensions/filters/network/http_connection_manager/v3alpha:pkg",
"//envoy/extensions/filters/network/kafka_broker/v3alpha:pkg",
"//envoy/extensions/filters/network/local_ratelimit/v3alpha:pkg",
"//envoy/extensions/filters/network/mongo_proxy/v3alpha:pkg",
"//envoy/extensions/filters/network/mysql_proxy/v3alpha:pkg",
"//envoy/extensions/filters/network/ratelimit/v3alpha:pkg",
"//envoy/extensions/filters/network/rbac/v3alpha:pkg",
"//envoy/extensions/filters/network/redis_proxy/v3alpha:pkg",
"//envoy/extensions/filters/network/sni_cluster/v3alpha:pkg",
"//envoy/extensions/filters/network/tcp_proxy/v3alpha:pkg",
"//envoy/extensions/filters/network/thrift_proxy/filters/ratelimit/v3alpha:pkg",
"//envoy/extensions/filters/network/thrift_proxy/v3alpha:pkg",
"//envoy/extensions/filters/network/zookeeper_proxy/v3alpha:pkg",
"//envoy/extensions/retry/priority/previous_priorities/v3alpha:pkg",
"//envoy/extensions/transport_sockets/alts/v3alpha:pkg",
"//envoy/extensions/transport_sockets/raw_buffer/v3alpha:pkg",
"//envoy/extensions/transport_sockets/tap/v3alpha:pkg",
"//envoy/extensions/transport_sockets/tls/v3alpha:pkg",
"//envoy/data/tap/v3:pkg",
"//envoy/extensions/access_loggers/file/v3:pkg",
"//envoy/extensions/access_loggers/grpc/v3:pkg",
"//envoy/extensions/clusters/aggregate/v3:pkg",
"//envoy/extensions/clusters/dynamic_forward_proxy/v3:pkg",
"//envoy/extensions/clusters/redis/v3:pkg",
"//envoy/extensions/common/dynamic_forward_proxy/v3:pkg",
"//envoy/extensions/common/ratelimit/v3:pkg",
"//envoy/extensions/common/tap/v3:pkg",
"//envoy/extensions/filters/common/fault/v3:pkg",
"//envoy/extensions/filters/http/adaptive_concurrency/v3:pkg",
"//envoy/extensions/filters/http/buffer/v3:pkg",
"//envoy/extensions/filters/http/cors/v3:pkg",
"//envoy/extensions/filters/http/csrf/v3:pkg",
"//envoy/extensions/filters/http/dynamic_forward_proxy/v3:pkg",
"//envoy/extensions/filters/http/dynamo/v3:pkg",
"//envoy/extensions/filters/http/ext_authz/v3:pkg",
"//envoy/extensions/filters/http/fault/v3:pkg",
"//envoy/extensions/filters/http/grpc_http1_bridge/v3:pkg",
"//envoy/extensions/filters/http/grpc_http1_reverse_bridge/v3:pkg",
"//envoy/extensions/filters/http/grpc_json_transcoder/v3:pkg",
"//envoy/extensions/filters/http/grpc_stats/v3:pkg",
"//envoy/extensions/filters/http/grpc_web/v3:pkg",
"//envoy/extensions/filters/http/gzip/v3:pkg",
"//envoy/extensions/filters/http/header_to_metadata/v3:pkg",
"//envoy/extensions/filters/http/health_check/v3:pkg",
"//envoy/extensions/filters/http/ip_tagging/v3:pkg",
"//envoy/extensions/filters/http/jwt_authn/v3:pkg",
"//envoy/extensions/filters/http/lua/v3:pkg",
"//envoy/extensions/filters/http/on_demand/v3:pkg",
"//envoy/extensions/filters/http/original_src/v3:pkg",
"//envoy/extensions/filters/http/ratelimit/v3:pkg",
"//envoy/extensions/filters/http/rbac/v3:pkg",
"//envoy/extensions/filters/http/router/v3:pkg",
"//envoy/extensions/filters/http/squash/v3:pkg",
"//envoy/extensions/filters/http/tap/v3:pkg",
"//envoy/extensions/filters/listener/http_inspector/v3:pkg",
"//envoy/extensions/filters/listener/original_dst/v3:pkg",
"//envoy/extensions/filters/listener/original_src/v3:pkg",
"//envoy/extensions/filters/listener/proxy_protocol/v3:pkg",
"//envoy/extensions/filters/listener/tls_inspector/v3:pkg",
"//envoy/extensions/filters/network/client_ssl_auth/v3:pkg",
"//envoy/extensions/filters/network/dubbo_proxy/router/v3:pkg",
"//envoy/extensions/filters/network/dubbo_proxy/v3:pkg",
"//envoy/extensions/filters/network/echo/v3:pkg",
"//envoy/extensions/filters/network/ext_authz/v3:pkg",
"//envoy/extensions/filters/network/http_connection_manager/v3:pkg",
"//envoy/extensions/filters/network/kafka_broker/v3:pkg",
"//envoy/extensions/filters/network/local_ratelimit/v3:pkg",
"//envoy/extensions/filters/network/mongo_proxy/v3:pkg",
"//envoy/extensions/filters/network/mysql_proxy/v3:pkg",
"//envoy/extensions/filters/network/ratelimit/v3:pkg",
"//envoy/extensions/filters/network/rbac/v3:pkg",
"//envoy/extensions/filters/network/redis_proxy/v3:pkg",
"//envoy/extensions/filters/network/sni_cluster/v3:pkg",
"//envoy/extensions/filters/network/tcp_proxy/v3:pkg",
"//envoy/extensions/filters/network/thrift_proxy/filters/ratelimit/v3:pkg",
"//envoy/extensions/filters/network/thrift_proxy/v3:pkg",
"//envoy/extensions/filters/network/zookeeper_proxy/v3:pkg",
"//envoy/extensions/retry/priority/previous_priorities/v3:pkg",
"//envoy/extensions/transport_sockets/alts/v3:pkg",
"//envoy/extensions/transport_sockets/raw_buffer/v3:pkg",
"//envoy/extensions/transport_sockets/tap/v3:pkg",
"//envoy/extensions/transport_sockets/tls/v3:pkg",
"//envoy/service/accesslog/v2:pkg",
"//envoy/service/accesslog/v3alpha:pkg",
"//envoy/service/accesslog/v3:pkg",
"//envoy/service/auth/v2:pkg",
"//envoy/service/auth/v3alpha:pkg",
"//envoy/service/cluster/v3alpha:pkg",
"//envoy/service/auth/v3:pkg",
"//envoy/service/cluster/v3:pkg",
"//envoy/service/discovery/v2:pkg",
"//envoy/service/discovery/v3alpha:pkg",
"//envoy/service/endpoint/v3alpha:pkg",
"//envoy/service/health/v3alpha:pkg",
"//envoy/service/listener/v3alpha:pkg",
"//envoy/service/discovery/v3:pkg",
"//envoy/service/endpoint/v3:pkg",
"//envoy/service/health/v3:pkg",
"//envoy/service/listener/v3:pkg",
"//envoy/service/load_stats/v2:pkg",
"//envoy/service/load_stats/v3alpha:pkg",
"//envoy/service/load_stats/v3:pkg",
"//envoy/service/metrics/v2:pkg",
"//envoy/service/metrics/v3alpha:pkg",
"//envoy/service/metrics/v3:pkg",
"//envoy/service/ratelimit/v2:pkg",
"//envoy/service/ratelimit/v3alpha:pkg",
"//envoy/service/route/v3alpha:pkg",
"//envoy/service/runtime/v3alpha:pkg",
"//envoy/service/secret/v3alpha:pkg",
"//envoy/service/ratelimit/v3:pkg",
"//envoy/service/route/v3:pkg",
"//envoy/service/runtime/v3:pkg",
"//envoy/service/secret/v3:pkg",
"//envoy/service/tap/v2alpha:pkg",
"//envoy/service/tap/v3alpha:pkg",
"//envoy/service/tap/v3:pkg",
"//envoy/service/trace/v2:pkg",
"//envoy/service/trace/v3alpha:pkg",
"//envoy/service/trace/v3:pkg",
"//envoy/type:pkg",
"//envoy/type/matcher:pkg",
"//envoy/type/matcher/v3alpha:pkg",
"//envoy/type/matcher/v3:pkg",
"//envoy/type/metadata/v2:pkg",
"//envoy/type/tracing/v2:pkg",
"//envoy/type/v3alpha:pkg",
"//envoy/type/v3:pkg",
],
)
2 changes: 1 addition & 1 deletion api/STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ To add an extension config to the API, the steps below should be followed:
)
```
1. Add to the v2 extension config proto `import "udpa/annotations/migrate.proto";`
2. Add to the v2 extension config proto a package level `option (udpa.annotations.file_migrate).move_to_package = "envoy.extensions.filters.http.foobar.v3alpha";`.
2. Add to the v2 extension config proto a package level `option (udpa.annotations.file_migrate).move_to_package = "envoy.extensions.filters.http.foobar.v3";`.
This places the filter in the correct [v3 package hierarchy](#package-organization).
3. Add a reference to the v2 extension config in (1) in [api/docs/BUILD](docs/BUILD).
4. Run `./tools/proto_format fix`. This should regenerate the `BUILD` file,
Expand Down
17 changes: 17 additions & 0 deletions api/envoy/admin/v3/BUILD
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# DO NOT EDIT. This file is generated by tools/proto_sync.py.

load("@envoy_api//bazel:api_build_system.bzl", "api_proto_package")

licenses(["notice"]) # Apache 2

api_proto_package(
deps = [
"//envoy/admin/v2alpha:pkg",
"//envoy/annotations:pkg",
"//envoy/config/bootstrap/v3:pkg",
"//envoy/config/core/v3:pkg",
"//envoy/config/tap/v3:pkg",
"//envoy/type/v3:pkg",
"@com_github_cncf_udpa//udpa/annotations:pkg",
],
)
69 changes: 69 additions & 0 deletions api/envoy/admin/v3/certs.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
syntax = "proto3";

package envoy.admin.v3;

import "google/protobuf/timestamp.proto";

import "udpa/annotations/versioning.proto";

option java_package = "io.envoyproxy.envoy.admin.v3";
option java_outer_classname = "CertsProto";
option java_multiple_files = true;

// [#protodoc-title: Certificates]

// Proto representation of certificate details. Admin endpoint uses this wrapper for `/certs` to
// display certificate information. See :ref:`/certs <operations_admin_interface_certs>` for more
// information.
message Certificates {
option (udpa.annotations.versioning).previous_message_type = "envoy.admin.v2alpha.Certificates";

// List of certificates known to an Envoy.
repeated Certificate certificates = 1;
}

message Certificate {
option (udpa.annotations.versioning).previous_message_type = "envoy.admin.v2alpha.Certificate";

// Details of CA certificate.
repeated CertificateDetails ca_cert = 1;

// Details of Certificate Chain
repeated CertificateDetails cert_chain = 2;
}

// [#next-free-field: 7]
message CertificateDetails {
option (udpa.annotations.versioning).previous_message_type =
"envoy.admin.v2alpha.CertificateDetails";

// Path of the certificate.
string path = 1;

// Certificate Serial Number.
string serial_number = 2;

// List of Subject Alternate names.
repeated SubjectAlternateName subject_alt_names = 3;

// Minimum of days until expiration of certificate and it's chain.
uint64 days_until_expiration = 4;

// Indicates the time from which the certificate is valid.
google.protobuf.Timestamp valid_from = 5;

// Indicates the time at which the certificate expires.
google.protobuf.Timestamp expiration_time = 6;
}

message SubjectAlternateName {
option (udpa.annotations.versioning).previous_message_type =
"envoy.admin.v2alpha.SubjectAlternateName";

// Subject Alternate Name.
oneof name {
string dns = 1;

string uri = 2;
}
}
Loading

0 comments on commit 5248a4f

Please sign in to comment.