docs: playground doc updates

.circleci/config.yml

@@ -239,7 +239,7 @@ workflows:
             (go.mod|go.sum) updated-aperture true
             docs/.* updated-aperture-docs true
             manifests/charts/.* updated-aperture-charts true
-            tools/demo_app/.* updated-demo-app true
+            playground/demo_app/.* updated-demo-app true
             sdks/aperture-go/.* updated-aperture-go true
             sdks/aperture-java/.* updated-aperture-java true
 

.circleci/continue-workflows.yml

@@ -700,8 +700,8 @@ workflows:
           dockerhub-image: fluxninja/demo-app
           gcr-registry: gcr.io/devel-309501
           gcr-image: cf-fn/demo-app
-          docker-context: .
-          dockerfile: tools/demo_app/Dockerfile
+          docker-context: ./playground/demo_app
+          dockerfile: ./playground/demo_app/Dockerfile
           use-docker-layer-caching: true
           push-to-dockerhub: false
 

.tool-versions

@@ -1,20 +1,20 @@
 pre-commit 2.20.0
 bats 1.7.0
 gcloud 395.0.0
-golang 1.19.1
-golangci-lint 1.49.0
-grpcurl 1.8.6
+golang 1.19.2
+golangci-lint 1.50.1
+grpcurl 1.8.7
 mockery 2.14.0
-buf 1.8.0
+buf 1.9.0
 nodejs 16.16.0
 python 3.10.6
 shellcheck 0.8.0
-yq 4.27.5
-helm 3.9.4
-kubectl 1.25.1
+yq 4.28.2
+helm 3.10.1
+kubectl 1.25.3
 kustomize 4.5.7
-kind 0.15.0
+kind 0.16.0
 jb 0.5.1
 tanka 0.23.1
-tilt 0.30.8
+tilt 0.30.9
 jsonnet 0.18.0

README.md

@@ -85,8 +85,12 @@ To try aperture in a local Kubernetes environment, refer to
 ### 🏎️ Installation
 
 To install Aperture system, please follow the
-[Installation](https://docs.fluxninja.com/docs/development/category/installation)
-guide.
+[Installation](https://docs.fluxninja.com/docs/category/installation) guide.
+
+### 📖 Tutorials
+
+To learn how to write Aperture policies, please read the
+[Tutorials](https://docs.fluxninja.com/docs/category/tutorials).
 
 ## 👷 Contributing
 

api/aperture/common/entitycache/v1/entitycache.proto

@@ -13,33 +13,21 @@ import "protoc-gen-openapiv2/options/annotations.proto";
 // EntityCacheService is used to query EntityCache.
 service EntityCacheService {
   rpc GetEntityCache(google.protobuf.Empty) returns (EntityCache) {
-    option (google.api.http) = {
-      get: "/v1/entities"
-    };
+    option (google.api.http) = {get: "/v1/entities"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      tags: [
-        "aperture-agent"
-      ];
+      tags: ["aperture-agent"];
     };
   }
   rpc GetEntityByIPAddress(GetEntityByIPAddressRequest) returns (Entity) {
-    option (google.api.http) = {
-      get: "/v1/entities/ip-address/{ip_address}"
-    };
+    option (google.api.http) = {get: "/v1/entities/ip-address/{ip_address}"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      tags: [
-        "aperture-agent"
-      ];
+      tags: ["aperture-agent"];
     };
   }
   rpc GetEntityByName(GetEntityByNameRequest) returns (Entity) {
-    option (google.api.http) = {
-      get: "/v1/entities/name/{name}"
-    };
+    option (google.api.http) = {get: "/v1/entities/name/{name}"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      tags: [
-        "aperture-agent"
-      ];
+      tags: ["aperture-agent"];
     };
   }
 }

api/aperture/common/info/v1/info.proto

@@ -11,9 +11,7 @@ import "protoc-gen-openapiv2/options/annotations.proto";
 // InfoService is used to provide information about the aperture system.
 service InfoService {
   rpc Version(google.protobuf.Empty) returns (VersionInfo) {
-    option (google.api.http) = {
-      get: "/v1/info/version"
-    };
+    option (google.api.http) = {get: "/v1/info/version"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
       tags: [
         "aperture-agent",
@@ -22,9 +20,7 @@ service InfoService {
     };
   }
   rpc Process(google.protobuf.Empty) returns (ProcessInfo) {
-    option (google.api.http) = {
-      get: "/v1/info/process"
-    };
+    option (google.api.http) = {get: "/v1/info/process"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
       tags: [
         "aperture-agent",
@@ -33,9 +29,7 @@ service InfoService {
     };
   }
   rpc Host(google.protobuf.Empty) returns (HostInfo) {
-    option (google.api.http) = {
-      get: "/v1/info/host"
-    };
+    option (google.api.http) = {get: "/v1/info/host"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
       tags: [
         "aperture-agent",

api/aperture/common/labelmatcher/v1/labelmatcher.proto

@@ -37,9 +37,7 @@ message K8sLabelMatcherRequirement {
   string key = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
     extensions: {
       key: "x-go-validate"
-      value: {
-        string_value: "required"
-      }
+      value: {string_value: "required"}
     }
   }]; // @gotags: validate:"required"
 
@@ -48,9 +46,7 @@ message K8sLabelMatcherRequirement {
   string operator = 2 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
     extensions: {
       key: "x-go-validate"
-      value: {
-        string_value: "oneof=In NotIn Exists DoesNotExists"
-      }
+      value: {string_value: "oneof=In NotIn Exists DoesNotExists"}
     }
   }]; // @gotags: validate:"oneof=In NotIn Exists DoesNotExists"
 
@@ -95,9 +91,7 @@ message MatchExpression {
     string label_exists = 4 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
       extensions: {
         key: "x-go-validate"
-        value: {
-          string_value: "required"
-        }
+        value: {string_value: "required"}
       }
     }]; // @gotags: validate:"required"
 
@@ -115,9 +109,7 @@ message EqualsMatchExpression {
   string label = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
     extensions: {
       key: "x-go-validate"
-      value: {
-        string_value: "required"
-      }
+      value: {string_value: "required"}
     }
   }]; // @gotags: validate:"required"
 
@@ -131,9 +123,7 @@ message MatchesMatchExpression {
   string label = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
     extensions: {
       key: "x-go-validate"
-      value: {
-        string_value: "required"
-      }
+      value: {string_value: "required"}
     }
   }]; // @gotags: validate:"required"
 
@@ -142,9 +132,7 @@ message MatchesMatchExpression {
   string regex = 2 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
     extensions: {
       key: "x-go-validate"
-      value: {
-        string_value: "required"
-      }
+      value: {string_value: "required"}
     }
   }]; // @gotags: validate:"required"
 }

api/aperture/common/peers/v1/peers.proto

@@ -13,24 +13,16 @@ import "protoc-gen-openapiv2/options/annotations.proto";
 // PeerDiscoveryService is used to query Peers.
 service PeerDiscoveryService {
   rpc GetPeers(google.protobuf.Empty) returns (Peers) {
-    option (google.api.http) = {
-      get: "/v1/peers"
-    };
+    option (google.api.http) = {get: "/v1/peers"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      tags: [
-        "aperture-agent"
-      ];
+      tags: ["aperture-agent"];
     };
   }
 
   rpc GetPeer(PeerRequest) returns (Peer) {
-    option (google.api.http) = {
-      get: "/v1/peers/address/{address}"
-    };
+    option (google.api.http) = {get: "/v1/peers/address/{address}"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
-      tags: [
-        "aperture-agent"
-      ];
+      tags: ["aperture-agent"];
     };
   }
 }

api/aperture/common/selector/v1/selector.proto

@@ -16,17 +16,13 @@ message Selector {
   ServiceSelector service_selector = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
     extensions: {
       key: "x-go-validate"
-      value: {
-        string_value: "required"
-      }
+      value: {string_value: "required"}
     }
   }]; // @gotags: validate:"required"
   FlowSelector flow_selector = 2 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
     extensions: {
       key: "x-go-validate"
-      value: {
-        string_value: "required"
-      }
+      value: {string_value: "required"}
     }
   }]; // @gotags: validate:"required"
 }
@@ -44,9 +40,7 @@ message ServiceSelector {
   string agent_group = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
     extensions: {
       key: "x-go-default"
-      value: {
-        string_value: "default"
-      }
+      value: {string_value: "default"}
     }
   }]; // @gotags: default:"default"
 
@@ -94,9 +88,7 @@ message FlowSelector {
   ControlPoint control_point = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
     extensions: {
       key: "x-go-validate"
-      value: {
-        string_value: "required"
-      }
+      value: {string_value: "required"}
     }
   }]; // @gotags: validate:"required"
 
@@ -133,9 +125,7 @@ message ControlPoint {
     string feature = 1 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
       extensions: {
         key: "x-go-validate"
-        value: {
-          string_value: "required"
-        }
+        value: {string_value: "required"}
       }
     }]; //@gotags: validate:"required"
 
@@ -148,9 +138,7 @@ message ControlPoint {
     string traffic = 2 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
       extensions: {
         key: "x-go-validate"
-        value: {
-          string_value: "required,oneof=ingress egress"
-        }
+        value: {string_value: "required,oneof=ingress egress"}
       }
     }]; // @gotags: validate:"required,oneof=ingress egress"
   }

api/aperture/common/status/v1/status.proto

@@ -14,9 +14,7 @@ import "protoc-gen-openapiv2/options/annotations.proto";
 // StatusService is used to query Jobs.
 service StatusService {
   rpc GetGroupStatus(GroupStatusRequest) returns (GroupStatus) {
-    option (google.api.http) = {
-      get: "/v1/status/{path=**}"
-    };
+    option (google.api.http) = {get: "/v1/status/{path=**}"};
     option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
       tags: [
         "aperture-agent",

api/aperture/plugins/fluxninja/v1/heartbeat.proto

@@ -23,9 +23,7 @@ service FluxNinjaService {
 // ControllerInfoService is used to read controllerID to which agent/controller belong.
 service ControllerInfoService {
   rpc GetControllerInfo(google.protobuf.Empty) returns (ControllerInfo) {
-    option (google.api.http) = {
-      get: "/plugins/fluxninja/v1/controllerinfo"
-    };
+    option (google.api.http) = {get: "/plugins/fluxninja/v1/controllerinfo"};
   }
 }