Skip to content

Commit a3b4aa9

Browse files
authored
Merge pull request #25 from cheftako/master
apiserver-network-proxy flags should use kebab-case not camelCase
2 parents b82dffb + 82d0998 commit a3b4aa9

File tree

5 files changed

+35
-33
lines changed

5 files changed

+35
-33
lines changed

Makefile

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,18 @@ bin/proxy-agent: bin cmd/agent/main.go proto/agent/agent.pb.go
3434

3535
docker/proxy-agent: cmd/agent/main.go proto/agent/agent.pb.go
3636
@[ "${REGISTRY}" ] || ( echo "REGISTRY is not set"; exit 1 )
37+
@[ "${VERSION}" ] || ( echo "VERSION is not set"; exit 1 )
3738
@[ "${PROJECT_ID}" ] || ( echo "PROJECT_ID is not set"; exit 1 )
38-
docker build . -f artifacts/images/agent-build.Dockerfile -t ${REGISTRY}/${PROJECT_ID}/proxy-agent:latest
39+
docker build . -f artifacts/images/agent-build.Dockerfile -t ${REGISTRY}/${PROJECT_ID}/proxy-agent:${VERSION}
3940

4041
bin/proxy-server: bin cmd/proxy/main.go proto/agent/agent.pb.go proto/proxy.pb.go
4142
go build -o bin/proxy-server cmd/proxy/main.go
4243

4344
docker/proxy-server: cmd/proxy/main.go proto/agent/agent.pb.go proto/proxy.pb.go
4445
@[ "${REGISTRY}" ] || ( echo "REGISTRY is not set"; exit 1 )
46+
@[ "${VERSION}" ] || ( echo "VERSION is not set"; exit 1 )
4547
@[ "${PROJECT_ID}" ] || ( echo "PROJECT_ID is not set"; exit 1 )
46-
docker build . -f artifacts/images/server-build.Dockerfile -t ${REGISTRY}/${PROJECT_ID}/proxy-server:latest
48+
docker build . -f artifacts/images/server-build.Dockerfile -t ${REGISTRY}/${PROJECT_ID}/proxy-server:${VERSION}
4749

4850
bin/proxy-test-client: bin cmd/client/main.go proto/proxy.pb.go
4951
go build -o bin/proxy-test-client cmd/client/main.go
@@ -97,8 +99,8 @@ build: bin/proxy-agent bin/proxy-server bin/proxy-test-client
9799

98100
push-images: docker/proxy-agent docker/proxy-server
99101
@[ "${DOCKER_CMD}" ] || ( echo "DOCKER_CMD is not set"; exit 1 )
100-
${DOCKER_CMD} push ${REGISTRY}/${PROJECT_ID}/proxy-agent:latest
101-
${DOCKER_CMD} push ${REGISTRY}/${PROJECT_ID}/proxy-server:latest
102+
${DOCKER_CMD} push ${REGISTRY}/${PROJECT_ID}/proxy-agent:${VERSION}
103+
${DOCKER_CMD} push ${REGISTRY}/${PROJECT_ID}/proxy-server:${VERSION}
102104

103105
clean:
104106
rm -rf proto/agent/agent.pb.go proto/proxy.pb.go easy-rsa.tar.gz easy-rsa-master cfssl cfssljson certs bin

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,17 +61,17 @@ python -m SimpleHTTPServer
6161

6262
- Start proxy service
6363
```console
64-
./bin/proxy-server --serverCaCert=certs/master/issued/ca.crt --serverCert=certs/master/issued/proxy-master.crt --serverKey=certs/master/private/proxy-master.key --clusterCaCert=certs/agent/issued/ca.crt --clusterCert=certs/agent/issued/proxy-master.crt --clusterKey=certs/agent/private/proxy-master.key
64+
./bin/proxy-server --server-ca-cert=certs/master/issued/ca.crt --server-cert=certs/master/issued/proxy-master.crt --server-key=certs/master/private/proxy-master.key --cluster-ca-cert=certs/agent/issued/ca.crt --cluster-cert=certs/agent/issued/proxy-master.crt --cluster-key=certs/agent/private/proxy-master.key
6565
```
6666

6767
- Start agent service
6868
```console
69-
./bin/proxy-agent --caCert=certs/agent/issued/ca.crt --agentCert=certs/agent/issued/proxy-agent.crt --agentKey=certs/agent/private/proxy-agent.key
69+
./bin/proxy-agent --ca-cert=certs/agent/issued/ca.crt --agent-cert=certs/agent/issued/proxy-agent.crt --agent-key=certs/agent/private/proxy-agent.key
7070
```
7171

7272
- Run client (mTLS enabled sample client)
7373
```console
74-
./bin/proxy-test-client --caCert=certs/master/issued/ca.crt --clientCert=certs/master/issued/proxy-client.crt --clientKey=certs/master/private/proxy-client.key
74+
./bin/proxy-test-client --ca-cert=certs/master/issued/ca.crt --client-cert=certs/master/issued/proxy-client.crt --client-key=certs/master/private/proxy-client.key
7575
```
7676

7777
### HTTP-Connect Client using mTLS Proxy with dial back Agent (Either curl OR test client)
@@ -90,17 +90,17 @@ python -m SimpleHTTPServer
9090

9191
- Start proxy service
9292
```console
93-
./bin/proxy-server --mode=http-connect --serverCaCert=certs/master/issued/ca.crt --serverCert=certs/master/issued/proxy-master.crt --serverKey=certs/master/private/proxy-master.key --clusterCaCert=certs/agent/issued/ca.crt --clusterCert=certs/agent/issued/proxy-master.crt --clusterKey=certs/agent/private/proxy-master.key
93+
./bin/proxy-server --mode=http-connect --server-ca-cert=certs/master/issued/ca.crt --server-cert=certs/master/issued/proxy-master.crt --server-key=certs/master/private/proxy-master.key --cluster-ca-cert=certs/agent/issued/ca.crt --cluster-cert=certs/agent/issued/proxy-master.crt --cluster-key=certs/agent/private/proxy-master.key
9494
```
9595

9696
- Start agent service
9797
```console
98-
./bin/proxy-agent --caCert=certs/agent/issued/ca.crt --agentCert=certs/agent/issued/proxy-agent.crt --agentKey=certs/agent/private/proxy-agent.key
98+
./bin/proxy-agent --ca-cert=certs/agent/issued/ca.crt --agent-cert=certs/agent/issued/proxy-agent.crt --agent-key=certs/agent/private/proxy-agent.key
9999
```
100100

101101
- Run client (mTLS & http-connect enabled sample client)
102102
```console
103-
./bin/proxy-test-client --mode=http-connect --proxyHost=127.0.0.1 --caCert=certs/master/issued/ca.crt --clientCert=certs/master/issued/proxy-client.crt --clientKey=certs/master/private/proxy-client.key
103+
./bin/proxy-test-client --mode=http-connect --proxy-host=127.0.0.1 --ca-cert=certs/master/issued/ca.crt --client-cert=certs/master/issued/proxy-client.crt --client-key=certs/master/private/proxy-client.key
104104
```
105105

106106
- Run curl client (curl using a mTLS http-connect proxy)

cmd/agent/main.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,11 @@ type GrpcProxyAgentOptions struct {
6767

6868
func (o *GrpcProxyAgentOptions) Flags() *pflag.FlagSet {
6969
flags := pflag.NewFlagSet("proxy-agent", pflag.ContinueOnError)
70-
flags.StringVar(&o.agentCert, "agentCert", o.agentCert, "If non-empty secure communication with this cert.")
71-
flags.StringVar(&o.agentKey, "agentKey", o.agentKey, "If non-empty secure communication with this key.")
72-
flags.StringVar(&o.caCert, "caCert", o.caCert, "If non-empty the CAs we use to validate clients.")
73-
flags.StringVar(&o.proxyServerHost, "proxyServerHost", o.proxyServerHost, "The hostname to use to connect to the proxy-server.")
74-
flags.IntVar(&o.proxyServerPort, "proxyServerPort", o.proxyServerPort, "The port the proxy server is listening on.")
70+
flags.StringVar(&o.agentCert, "agent-cert", o.agentCert, "If non-empty secure communication with this cert.")
71+
flags.StringVar(&o.agentKey, "agent-key", o.agentKey, "If non-empty secure communication with this key.")
72+
flags.StringVar(&o.caCert, "ca-cert", o.caCert, "If non-empty the CAs we use to validate clients.")
73+
flags.StringVar(&o.proxyServerHost, "proxy-server-host", o.proxyServerHost, "The hostname to use to connect to the proxy-server.")
74+
flags.IntVar(&o.proxyServerPort, "proxy-server-port", o.proxyServerPort, "The port the proxy server is listening on.")
7575
return flags
7676
}
7777

cmd/client/main.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,15 +73,15 @@ type GrpcProxyClientOptions struct {
7373

7474
func (o *GrpcProxyClientOptions) Flags() *pflag.FlagSet {
7575
flags := pflag.NewFlagSet("proxy", pflag.ContinueOnError)
76-
flags.StringVar(&o.clientCert, "clientCert", o.clientCert, "If non-empty secure communication with this cert.")
77-
flags.StringVar(&o.clientKey, "clientKey", o.clientKey, "If non-empty secure communication with this key.")
78-
flags.StringVar(&o.caCert, "caCert", o.caCert, "If non-empty the CAs we use to validate clients.")
79-
flags.StringVar(&o.requestProto, "requestProto", o.requestProto, "The protocol for the request to send through the proxy.")
80-
flags.StringVar(&o.requestPath, "requestPath", o.requestPath, "The url request to send through the proxy.")
81-
flags.StringVar(&o.requestHost, "requestHost", o.requestHost, "The host of the request server.")
82-
flags.IntVar(&o.requestPort, "requestPort", o.requestPort, "The port the request server is listening on.")
83-
flags.StringVar(&o.proxyHost, "proxyHost", o.proxyHost, "The host of the proxy server.")
84-
flags.IntVar(&o.proxyPort, "proxyPort", o.proxyPort, "The port the proxy server is listening on.")
76+
flags.StringVar(&o.clientCert, "client-cert", o.clientCert, "If non-empty secure communication with this cert.")
77+
flags.StringVar(&o.clientKey, "client-key", o.clientKey, "If non-empty secure communication with this key.")
78+
flags.StringVar(&o.caCert, "ca-cert", o.caCert, "If non-empty the CAs we use to validate clients.")
79+
flags.StringVar(&o.requestProto, "request-proto", o.requestProto, "The protocol for the request to send through the proxy.")
80+
flags.StringVar(&o.requestPath, "request-path", o.requestPath, "The url request to send through the proxy.")
81+
flags.StringVar(&o.requestHost, "request-host", o.requestHost, "The host of the request server.")
82+
flags.IntVar(&o.requestPort, "request-port", o.requestPort, "The port the request server is listening on.")
83+
flags.StringVar(&o.proxyHost, "proxy-host", o.proxyHost, "The host of the proxy server.")
84+
flags.IntVar(&o.proxyPort, "proxy-port", o.proxyPort, "The port the proxy server is listening on.")
8585
flags.StringVar(&o.mode, "mode", o.mode, "Mode can be either 'grpc' or 'http-connect'.")
8686

8787
return flags

cmd/proxy/main.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -78,16 +78,16 @@ type ProxyRunOptions struct {
7878

7979
func (o *ProxyRunOptions) Flags() *pflag.FlagSet {
8080
flags := pflag.NewFlagSet("proxy-server", pflag.ContinueOnError)
81-
flags.StringVar(&o.serverCert, "serverCert", o.serverCert, "If non-empty secure communication with this cert.")
82-
flags.StringVar(&o.serverKey, "serverKey", o.serverKey, "If non-empty secure communication with this key.")
83-
flags.StringVar(&o.serverCaCert, "serverCaCert", o.serverCaCert, "If non-empty the CA we use to validate KAS clients.")
84-
flags.StringVar(&o.clusterCert, "clusterCert", o.clusterCert, "If non-empty secure communication with this cert.")
85-
flags.StringVar(&o.clusterKey, "clusterKey", o.clusterKey, "If non-empty secure communication with this key.")
86-
flags.StringVar(&o.clusterCaCert, "clusterCaCert", o.clusterCaCert, "If non-empty the CA we use to validate Agent clients.")
81+
flags.StringVar(&o.serverCert, "server-cert", o.serverCert, "If non-empty secure communication with this cert.")
82+
flags.StringVar(&o.serverKey, "server-key", o.serverKey, "If non-empty secure communication with this key.")
83+
flags.StringVar(&o.serverCaCert, "server-ca-cert", o.serverCaCert, "If non-empty the CA we use to validate KAS clients.")
84+
flags.StringVar(&o.clusterCert, "cluster-cert", o.clusterCert, "If non-empty secure communication with this cert.")
85+
flags.StringVar(&o.clusterKey, "cluster-key", o.clusterKey, "If non-empty secure communication with this key.")
86+
flags.StringVar(&o.clusterCaCert, "cluster-ca-cert", o.clusterCaCert, "If non-empty the CA we use to validate Agent clients.")
8787
flags.StringVar(&o.mode, "mode", "grpc", "Mode can be either 'grpc' or 'http-connect'.")
88-
flags.UintVar(&o.serverPort, "serverPort", 8090, "Port we listen for server connections on.")
89-
flags.UintVar(&o.agentPort, "agentPort", 8091, "Port we listen for agent connections on.")
90-
flags.UintVar(&o.adminPort, "adminPort", 8092, "Port we listen for admin connections on.")
88+
flags.UintVar(&o.serverPort, "server-port", 8090, "Port we listen for server connections on.")
89+
flags.UintVar(&o.agentPort, "agent-port", 8091, "Port we listen for agent connections on.")
90+
flags.UintVar(&o.adminPort, "admin-port", 8092, "Port we listen for admin connections on.")
9191
return flags
9292
}
9393

0 commit comments

Comments
 (0)