Update/create readme for generating protobuf files for logcache, loggregator and locket

Author: svkrieger

lib/locket/README.md

@@ -0,0 +1,29 @@
+To generate the locket protobuf files:
+
+1. Install protoc 30.2 from https://github.com/protocolbuffers/protobuf/releases
+
+2. Generate protobuf files:
+
+```
+#!/bin/bash
+
+gem install grpc-tools
+
+tmp_dir=$(mktemp -d)
+echo "Temp dir: $tmp_dir"
+
+pushd $tmp_dir
+  git clone --depth 1 "https://github.com/cloudfoundry/locket.git"
+  mv locket/models/locket.proto locket/
+popd
+
+out_dir=$(mktemp -d)
+echo "Out dir: $out_dir"
+RUBY_OUT=$out_dir/ruby-out
+GRPC_OUT=$out_dir/grpc-out
+mkdir -p  $RUBY_OUT $GRPC_OUT
+
+protoc --plugin=protoc-gen-grpc=`which grpc_tools_ruby_protoc_plugin` --proto_path=$tmp_dir --ruby_out=$RUBY_OUT --grpc_out=$GRPC_OUT  $tmp_dir/locket/locket.proto
+```
+
+3. Copy `$out_dir/ruby_out/locket/*` and `$out_dir/grpc_out/locket` into `lib/locket`.

lib/logcache/README.md

@@ -1,68 +1,36 @@
-This is taken from code.cloudfoundry.org/go-log-cache/rpc/logcache_v1/generate.sh
+This is taken from [github.com/cloudfoundry/go-log-cache/rpc/logcache_v1/generate.sh](https://github.com/cloudfoundry/go-log-cache/blob/main/rpc/logcache_v1/generate.sh)
 
-To generate the two logcache egress*pb.rb files:
+1. Install protoc 30.2 from https://github.com/protocolbuffers/protobuf/releases
 
-`grpc_tools_ruby_protoc` comes from doing `gem install grpc-tools`
+2. Generate protobuf files:
 
 ```
 #!/bin/bash
 
-
-go get github.com/golang/protobuf/{proto,protoc-gen-go}
-go get github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway
-go get code.cloudfoundry.org/log-cache
+gem install grpc-tools
 
 tmp_dir=$(mktemp -d)
-mkdir -p $tmp_dir/log-cache
-
-trash_dir=$(mktemp -d)
-
-cp $GOPATH/src/code.cloudfoundry.org/log-cache/api/v1/*proto $tmp_dir/log-cache
+echo "Temp dir: $tmp_dir"
+mkdir -p $tmp_dir/logcache
 
 pushd $tmp_dir
-  git clone https://github.com/cloudfoundry/loggregator-api
+  git clone --depth 1 https://github.com/cloudfoundry/loggregator-api.git
+  git clone --depth 1 https://github.com/googleapis/googleapis.git
+  mv googleapis/google .
+  rm -rf googleapis
+
+  git clone --depth 1 https://github.com/cloudfoundry/go-log-cache.git
+  cp go-log-cache/api/v1/*.proto logcache/
+  rm -rf go-log-cache
 popd
 
-RUBY_OUT=$trash_dir/log-cache/ruby-out
-GRPC_OUT=$trash_dir/log-cache/grpc-out
-mkdir -p  $RUBY_OUT $GRPC_OUT
-grpc_tools_ruby_protoc \
-    $tmp_dir/log-cache/*.proto \
-    --go_out=plugins=grpc,Mv2/envelope.proto=code.cloudfoundry.org/go-loggregator/rpc/loggregator_v2:. \
-    --ruby_out=$RUBY_OUT \
-    --grpc_out=$GRPC_OUT \
-    --proto_path=$tmp_dir/log-cache \
-    --grpc-gateway_out=logtostderr=true:. \
-    -I$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
-    -I=/usr/local/include \
-    -I=$tmp_dir/log-cache \
-    -I=$tmp_dir/loggregator-api/.
-```
-
-You want `$trash_dir/log-cache/ruby-out/egress_pb.rb` and  `$trash_dir/log-cache/grpc-out/egress_services_pb.rb`
-
-
-To generate the two v2/envelope_pb.rb file:
-
-```
-mkdir -p $tmp_dir/loggregator-api
-cp $GOPATH/src/code.cloudfoundry.org/loggregator-api/v2/*proto $tmp_dir/loggregator-api/
-
-RUBY_OUT=$trash_dir/loggregator-api/ruby-out
-GRPC_OUT=$trash_dir/loggregator-api/grpc-out
+out_dir=$(mktemp -d)
+echo "Out dir: $out_dir"
+RUBY_OUT=$out_dir/ruby-out
+GRPC_OUT=$out_dir/grpc-out
 mkdir -p  $RUBY_OUT $GRPC_OUT
-grpc_tools_ruby_protoc \
-    $tmp_dir/loggregator-api/*.proto \
-    --go_out=plugins=grpc,Mv2/envelope.proto=code.cloudfoundry.org/go-loggregator/rpc/loggregator_v2:. \
-    --ruby_out=$RUBY_OUT \
-    --grpc_out=$GRPC_OUT \
-    --proto_path=$tmp_dir/loggregator-api \
-    --grpc-gateway_out=logtostderr=true:. \
-    -I$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
-    -I=/usr/local/include \
-    -I=$tmp_dir/log-cache \
-    -I=$GOPATH/src/code.cloudfoundry.org/loggregator-api/.
 
+protoc --plugin=protoc-gen-grpc=`which grpc_tools_ruby_protoc_plugin` --proto_path=$tmp_dir --ruby_out=$RUBY_OUT --grpc_out=$GRPC_OUT  $tmp_dir/logcache/*.proto
 ```
 
-You want `$trash_dir/ruby-out/envelope_pb.rb`
+3. Copy `$out_dir/ruby_out/logcache/*` and `$out_dir/grpc_out/logcache` into `lib/logcache`.

lib/loggregator-api/README.md

@@ -0,0 +1,19 @@
+To generate the envelope_pb.rb file:
+
+1. Install protoc 30.2 from https://github.com/protocolbuffers/protobuf/releases
+
+2. Generate protobuf files:
+
+```
+#!/bin/bash
+
+tmp_dir=$(mktemp -d)
+
+pushd $tmp_dir
+  git clone https://github.com/cloudfoundry/loggregator-api
+
+  protoc --ruby_out=. loggregator-api/v2/envelope.proto
+popd
+```
+
+3. Copy `$tmp_dir/envelope_pb.rb` to CC's `lib/loggregator-api/v2/`.