rename secure to tls

Signed-off-by: Asher Pemberton <asher.pemberton@arm.com>
Reviewed-by: Asher Pemberton <asher.pemberton@arm.com> # gatekeeper

Author: asher-pem-arm

doc/getting_started.rst

@@ -438,15 +438,15 @@ Follow these instructions to install the systemd files on your machine(s):
 Enabling gRPC connection security
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-It is encouraged to secure gRPC channels in a production environment.
+It is encouraged to use TLS for gRPC channels in a production environment.
 
-This can be enabled on the ``labgrid-coordinator`` by adding the ``--secure``,
+This can be enabled on the ``labgrid-coordinator`` by adding the ``--tls``,
 ``--cert`` and ``--key`` options.
 Refer to the ``labgrid-coordinator`` man page for details.
 
 When you are connecting with ``labgrid-client`` or ``labgrid-exporter`` to a
-``labgrid-coordinator``that has secure gRPC channels enabled you need to pass
-the ``--secure`` (and ``--cert`` if the certificate is not trusted by the host
+``labgrid-coordinator`` that has TLS gRPC channels enabled you need to pass
+the ``--tls`` (and ``--cert`` if the certificate is not trusted by the host
 machine) option.
 Refer to the ``labgrid-client`` and ``labgrid-exporter`` man pages for details.
 

doc/man/client.rst

@@ -54,6 +54,11 @@ LG_COORDINATOR
 This variable can be used to set the default coordinator in the format
 ``HOST[:PORT]`` (instead of using the ``-x`` option).
 
+LG_COORDINATOR_TLS
+~~~~~~~~~~~~~~~~~~
+This variable can be set to enable TLS gRPC channels without using the
+``--tls`` option.
+
 LG_PROXY
 ~~~~~~~~
 This variable can be used to specify a SSH proxy hostname which should be used
@@ -128,11 +133,11 @@ Add all resources with the group "example-group" to the place example-place:
 
    $ labgrid-client -p example-place add-match */example-group/*/*
 
-Retrieve a list of places on a ``labgrid-coordinator`` that uses secure gRPC channels:
+Retrieve a list of places on a ``labgrid-coordinator`` that uses TLS gRPC channels:
 
 .. code-block:: bash
 
-    $ labgrid-client --secure [--cert PATH] places
+    $ labgrid-client --tls [--cert PATH] places
 
 See Also
 --------

doc/man/coordinator.rst

@@ -25,7 +25,7 @@ OPTIONS
     display command line help
 -l ADDRESS, --listen ADDRESS
     make coordinator listen on host and port
---secure
+--tls
     enable TLS gRPC channel
 --cert
     path to TLS certificate (in PEM format)

doc/man/exporter.rst

@@ -27,7 +27,7 @@ OPTIONS
     display command line help
 -x, --coordinator
     coordinator ``HOST[:PORT]`` to connect to, defaults to ``127.0.0.1:20408``
---secure
+--tls
     enable TLS gRPC channel
 --cert
     path to TLS certificate (in PEM format)
@@ -103,11 +103,11 @@ Same as above, but with name ``myname``:
 
    $ labgrid-exporter -n myname my-config.yaml
 
-Same as above, but connecting to a ``labgrid-coordinator`` that uses secure gRPC channels:
+Same as above, but connecting to a ``labgrid-coordinator`` that uses TLS gRPC channels:
 
 .. code-block:: bash
 
-    $ labgrid-exporter --secure [--cert PATH] -n myname my-config.yaml
+    $ labgrid-exporter --tls [--cert PATH] -n myname my-config.yaml
 
 SEE ALSO
 --------

labgrid/remote/client.py

@@ -1864,9 +1864,9 @@ def get_parser(auto_doc_mode=False) -> "argparse.ArgumentParser | AutoProgramArg
         help="coordinator HOST[:PORT] (default: value from env variable LG_COORDINATOR, otherwise 127.0.0.1:20408)",
     )
     parser.add_argument(
-        "--secure",
+        "--tls",
         action="store_true",
-        default=os.environ.get("LG_COORDINATOR_SECURE") is not None,
+        default=os.environ.get("LG_COORDINATOR_TLS") is not None,
         help="enable TLS gRPC channel",
     )
     parser.add_argument("--cert", type=pathlib.PurePath, help="path to the server's TLS certificate (in PEM format)")

labgrid/remote/common.py

@@ -105,7 +105,7 @@ def _fetch_root_certificates():
 
 
 def get_client_credentials(args: Namespace) -> Optional[grpc.ChannelCredentials]:
-    if not args.secure:
+    if not args.tls:
         return None
 
     if not args.cert:

labgrid/remote/coordinator.py

@@ -1181,11 +1181,11 @@ def callback():
 
 
 def get_server_credentials(args: argparse.Namespace) -> Optional[grpc.ServerCredentials]:
-    if not args.secure:
+    if not args.tls:
         return None
 
     if not args.cert or not args.key:
-        raise RuntimeError("--cert and --key must be provided when --secure is provided")
+        raise RuntimeError("--cert and --key must be provided when --tls is provided")
 
     with open(args.key, "rb") as fk:
         with open(args.cert, "rb") as fc:
@@ -1202,7 +1202,7 @@ def main():
         default="[::]:20408",
         help="coordinator listening host and port",
     )
-    parser.add_argument("--secure", action="store_true", default=False, help="enable TLS to secure the gRPC channel")
+    parser.add_argument("--tls", action="store_true", default=False, help="enable TLS gRPC channel")
     parser.add_argument("--cert", type=pathlib.PurePath, help="path to TLS certificate (in PEM format)")
     parser.add_argument("--key", type=pathlib.PurePath, help="path to TLS key (in PEM format)")
     parser.add_argument("-d", "--debug", action="store_true", default=False, help="enable debug mode")

labgrid/remote/exporter.py

@@ -1089,7 +1089,7 @@ def main():
         default=os.environ.get("LG_COORDINATOR", "127.0.0.1:20408"),
         help="coordinator host and port",
     )
-    parser.add_argument("--secure", action="store_true", default=False, help="enable TLS to secure the gRPC channel")
+    parser.add_argument("--tls", action="store_true", default=False, help="enable TLS gRPC channel")
     parser.add_argument("--cert", type=pathlib.PurePath, help="path to TLS certificate (in PEM format)")
     parser.add_argument(
         "-n",

man/labgrid-client.1

@@ -39,7 +39,7 @@ This is the client to control a boards status and interface with it on remote ma
 .INDENT 3.5
 .sp
 .EX
-usage: labgrid\-client [\-x ADDRESS] [\-\-secure] [\-\-cert CERT] [\-c CONFIG]
+usage: labgrid\-client [\-x ADDRESS] [\-\-tls] [\-\-cert CERT] [\-c CONFIG]
                       [\-p PLACE] [\-s STATE] [\-i INITIAL_STATE] [\-d] [\-v]
                       [\-P PROXY]
                       COMMAND ...
@@ -53,7 +53,7 @@ coordinator HOST[:PORT] (default: value from env variable LG_COORDINATOR, otherw
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-\-secure
+.B \-\-tls
 enable TLS gRPC channel
 .UNINDENT
 .INDENT 0.0
@@ -1160,6 +1160,10 @@ using the \fB\-\-config\fP option, the \fB\-\-config\fP option overrides it.
 .sp
 This variable can be used to set the default coordinator in the format
 \fBHOST[:PORT]\fP (instead of using the \fB\-x\fP option).
+.SS LG_COORDINATOR_TLS
+.sp
+This variable can be set to enable TLS gRPC channels without using the
+\fB\-\-tls\fP option.
 .SS LG_PROXY
 .sp
 This variable can be used to specify a SSH proxy hostname which should be used
@@ -1242,12 +1246,12 @@ $ labgrid\-client \-p example\-place add\-match */example\-group/*/*
 .UNINDENT
 .UNINDENT
 .sp
-Retrieve a list of places on a \fBlabgrid\-coordinator\fP that uses secure gRPC channels:
+Retrieve a list of places on a \fBlabgrid\-coordinator\fP that uses TLS gRPC channels:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .EX
-$ labgrid\-client \-\-secure [\-\-cert PATH] places
+$ labgrid\-client \-\-tls [\-\-cert PATH] places
 .EE
 .UNINDENT
 .UNINDENT

man/labgrid-coordinator.1

@@ -51,7 +51,7 @@ display command line help
 .BI \-l \ ADDRESS\fR,\fB \ \-\-listen \ ADDRESS
 make coordinator listen on host and port
 .TP
-.B  \-\-secure
+.B  \-\-tls
 enable TLS gRPC channel
 .TP
 .B  \-\-cert