feat: rename engine to connector (#1229)

Co-authored-by: Jeffrey Morgan <jmorgan@mbp.local>
infrahq · Mar 18, 2022 · c0ebc01 · c0ebc01
1 parent 7e5b344
commit c0ebc01
Show file tree

Hide file tree

Showing 40 changed files with 585 additions and 585 deletions.
diff --git a/Makefile b/Makefile
@@ -26,7 +26,7 @@ helm/clean:
 	$(RM) -r helm/*.tgz
 
 .PHONY: docs
-docs: openapi
+docs: docs/api/openapi3.json
 	go run ./internal/docgen
 
 clean: helm/clean

diff --git a/README.md b/README.md
@@ -88,7 +88,7 @@ server:
         resource: infra
 
     # 2. Grant user(s) or group(s) access to a resources
-    # Example of granting access to an individual user the `cluster-admin` role. The name of a resource is specified when installing the Infra Engine at that location.
+    # Example of granting access to an individual user the `cluster-admin` role. The name of a resource is specified when installing the Infra connector at that location.
       - user: you@example.com
         role: cluster-admin                  # cluster_roles required
         resource: kubernetes.example-cluster # limit access to the `example-cluster` Kubernetes cluster
@@ -180,10 +180,10 @@ infra login <INFRA_API_SERVER>
 
 ### Step 5: Access the Cluster
 
-In order to get access to the cluster, the engine service must be accessible externally. The easiest way to achieve this is to use a LoadBalancer service.
+In order to get access to the cluster, the connector service must be accessible externally. The easiest way to achieve this is to use a LoadBalancer service.
 
 ```bash
-kubectl -n infrahq patch service infra-engine -p '{"spec": {"type": "LoadBalancer"}}'
+kubectl -n infrahq patch service infra-connector -p '{"spec": {"type": "LoadBalancer"}}'
 ```
 
 Switch to the cluster with Infra CLI.
@@ -207,7 +207,7 @@ Run the output Helm command on the Kubernetes cluster to be added.
 
 Example:
 ```
-helm upgrade --install infra-engine infrahq/infra --set engine.config.accessKey=2pVqDSdkTF.oSCEe6czoBWdgc6wRz0ywK8y --set engine.config.name=kubernetes.example-cluster --set engine.config.server=https://infra.acme.com
+helm upgrade --install infra-connector infrahq/infra --set connector.config.accessKey=2pVqDSdkTF.oSCEe6czoBWdgc6wRz0ywK8y --set connector.config.name=kubernetes.example-cluster --set connector.config.server=https://infra.acme.com
 ```
 
 ### Upgrade Infra

diff --git a/docker-desktop.yaml.in b/docker-desktop.yaml.in
@@ -18,7 +18,7 @@ server:
       role: cluster-admin
       resource: kubernetes.docker-desktop
 
-engine:
+connector:
   config:
     name: docker-desktop
 

diff --git a/docs/cli.md b/docs/cli.md
@@ -6,31 +6,31 @@
 * [infra logout](#infra-logout)
 * [infra list](#infra-list)
 * [infra use](#infra-use)
-* [infra access list](#infra-access-list)
-* [infra access grant](#infra-access-grant)
-* [infra access revoke](#infra-access-revoke)
+* [infra grants list](#infra-grants-list)
+* [infra grants add](#infra-grants-add)
+* [infra grants remove](#infra-grants-remove)
 * [infra keys list](#infra-keys-list)
-* [infra keys create](#infra-keys-create)
-* [infra keys delete](#infra-keys-delete)
+* [infra keys add](#infra-keys-add)
+* [infra keys remove](#infra-keys-remove)
 * [infra destinations list](#infra-destinations-list)
 * [infra destinations add](#infra-destinations-add)
 * [infra destinations remove](#infra-destinations-remove)
 * [infra providers list](#infra-providers-list)
 * [infra providers add](#infra-providers-add)
 * [infra providers remove](#infra-providers-remove)
-* [infra machines create](#infra-machines-create)
-* [infra machines list](#infra-machines-list)
-* [infra machines remove](#infra-machines-remove)
-* [infra tokens create](#infra-tokens-create)
+* [infra identities add](#infra-identities-add)
+* [infra identities list](#infra-identities-list)
+* [infra identities remove](#infra-identities-remove)
+* [infra tokens add](#infra-tokens-add)
 * [infra info](#infra-info)
 * [infra server](#infra-server)
-* [infra engine](#infra-engine)
+* [infra connector](#infra-connector)
 * [infra version](#infra-version)
 
 
 ## `infra login`
 
-Login to Infra server
+Login to Infra
 
 ```
 infra login [SERVER] [flags]
@@ -85,7 +85,7 @@ $ infra logout
 
 ## `infra list`
 
-List destinations and your access
+List accessible destinations
 
 ```
 infra list [flags]
@@ -106,7 +106,7 @@ infra list [flags]
 
 ## `infra use`
 
-Connect to a destination
+Access a destination
 
 ```
 infra use DESTINATION [flags]
@@ -137,12 +137,12 @@ $ infra use kubernetes.development.kube-system
       --non-interactive    don't assume an interactive terminal, even if there is one
 ```
 
-## `infra access list`
+## `infra grants list`
 
-List access
+List grants
 
 ```
-infra access list [DESTINATION] [flags]
+infra grants list [DESTINATION] [flags]
 ```
 
 ### Options
@@ -158,34 +158,34 @@ infra access list [DESTINATION] [flags]
       --non-interactive    don't assume an interactive terminal, even if there is one
 ```
 
-## `infra access grant`
+## `infra grants add`
 
-Grant access
+Grant access to a destination
 
 ```
-infra access grant DESTINATION [flags]
+infra grants add DESTINATION [flags]
 ```
 
 ### Examples
 
 ```
 
 # Grant user admin access to a cluster
-$ infra access grant -u suzie@acme.com -r admin kubernetes.production
+$ infra grants add -u suzie@acme.com -r admin kubernetes.production
 
 # Grant group admin access to a namespace
-$ infra access grant -g Engineering -r admin kubernetes.production.default
+$ infra grants add -g Engineering -r admin kubernetes.production.default
 
 # Grant user admin access to infra itself
-$ infra access grant -u admin@acme.com -r admin infra
+$ infra grants add -u admin@acme.com -r admin infra
 
 ```
 
 ### Options
 
 ```
   -g, --group string      Group to grant access to
-  -h, --help              help for grant
+  -h, --help              help for add
   -m, --machine string    Machine to grant access to
   -p, --provider string   Provider from which to grant user access to
   -r, --role string       Role to grant
@@ -199,19 +199,19 @@ $ infra access grant -u admin@acme.com -r admin infra
       --non-interactive    don't assume an interactive terminal, even if there is one
 ```
 
-## `infra access revoke`
+## `infra grants remove`
 
-Revoke access
+Revoke access to a destination
 
 ```
-infra access revoke DESTINATION [flags]
+infra grants remove DESTINATION [flags]
 ```
 
 ### Options
 
 ```
   -g, --group string      Group to revoke access from
-  -h, --help              help for revoke
+  -h, --help              help for remove
   -m, --machine string    Machine to revoke access from
   -p, --provider string   Provider from which to revoke access from
   -r, --role string       Role to revoke
@@ -247,12 +247,12 @@ infra keys list [flags]
       --non-interactive    don't assume an interactive terminal, even if there is one
 ```
 
-## `infra keys create`
+## `infra keys add`
 
 Create an access key for authentication
 
 ```
-infra keys create ACCESS_KEY_NAME MACHINE_NAME [flags]
+infra keys add ACCESS_KEY_NAME MACHINE_NAME [flags]
 ```
 
 ### Examples
@@ -268,7 +268,7 @@ infra keys create main wall-e 12h --extension-deadline=1h
 
 ```
   -e, --extension-deadline string   A specified deadline that an access key must be used within to remain valid
-  -h, --help                        help for create
+  -h, --help                        help for add
   -t, --ttl string                  The total time that an access key will be valid for
 ```
 
@@ -279,18 +279,18 @@ infra keys create main wall-e 12h --extension-deadline=1h
       --non-interactive    don't assume an interactive terminal, even if there is one
 ```
 
-## `infra keys delete`
+## `infra keys remove`
 
-Delete access keys
+Delete an access key
 
 ```
-infra keys delete ACCESS_KEY_NAME [flags]
+infra keys remove ACCESS_KEY_NAME [flags]
 ```
 
 ### Options
 
 ```
-  -h, --help   help for delete
+  -h, --help   help for remove
 ```
 
 ### Options inherited from parent commands
@@ -365,7 +365,7 @@ infra destinations remove DESTINATION [flags]
 
 ## `infra providers list`
 
-List identity providers
+List connected identity providers
 
 ```
 infra providers list [flags]
@@ -386,7 +386,7 @@ infra providers list [flags]
 
 ## `infra providers add`
 
-Add an identity provider
+Connect an identity provider
 
 ### Synopsis
 
@@ -437,19 +437,19 @@ infra providers remove PROVIDER [flags]
       --non-interactive    don't assume an interactive terminal, even if there is one
 ```
 
-## `infra machines create`
+## `infra identities add`
 
-Create a machine identity, e.g. a service that needs to access infrastructure
+Create a machine identity
 
 ```
-infra machines create NAME [flags]
+infra identities add NAME [flags]
 ```
 
 ### Options
 
 ```
   -d, --description string   Description of the machine identity
-  -h, --help                 help for create
+  -h, --help                 help for add
 ```
 
 ### Options inherited from parent commands
@@ -459,12 +459,12 @@ infra machines create NAME [flags]
       --non-interactive    don't assume an interactive terminal, even if there is one
 ```
 
-## `infra machines list`
+## `infra identities list`
 
-List machines
+List all identities (users & machines)
 
 ```
-infra machines list [flags]
+infra identities list [flags]
 ```
 
 ### Options
@@ -480,12 +480,12 @@ infra machines list [flags]
       --non-interactive    don't assume an interactive terminal, even if there is one
 ```
 
-## `infra machines remove`
+## `infra identities remove`
 
-Remove a machine identity
+Delete a machine identity
 
 ```
-infra machines remove MACHINE [flags]
+infra identities remove MACHINE [flags]
 ```
 
 ### Options
@@ -501,18 +501,18 @@ infra machines remove MACHINE [flags]
       --non-interactive    don't assume an interactive terminal, even if there is one
 ```
 
-## `infra tokens create`
+## `infra tokens add`
 
 Create a token
 
 ```
-infra tokens create [flags]
+infra tokens add [flags]
 ```
 
 ### Options
 
 ```
-  -h, --help   help for create
+  -h, --help   help for add
 ```
 
 ### Options inherited from parent commands
@@ -545,7 +545,7 @@ infra info [flags]
 
 ## `infra server`
 
-Start Infra server
+Start the Infra server
 
 ```
 infra server [flags]
@@ -583,20 +583,20 @@ infra server [flags]
       --non-interactive    don't assume an interactive terminal, even if there is one
 ```
 
-## `infra engine`
+## `infra connector`
 
-Start Infra Engine
+Start the Infra connector
 
 ```
-infra engine [flags]
+infra connector [flags]
 ```
 
 ### Options
 
 ```
   -a, --access-key string    Infra access key (use file:// to load from a file)
-  -f, --config-file string   Engine config file
-  -h, --help                 help for engine
+  -f, --config-file string   Connector config file
+  -h, --help                 help for connector
   -n, --name string          Destination name
   -s, --server string        Infra server hostname
       --skip-tls-verify      Skip verifying server TLS certificates

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -62,7 +62,7 @@ server:
   persistence:
     enabled: false
 
-engine:
+connector:
   pesistence:
     enabled: false
 ```
@@ -87,7 +87,7 @@ server:
   service:
     type: LoadBalancer
 
-engine:
+connector:
   service:
     type: LoadBalancer
     securePort: 8443  # to avoid colliding with infra-server's securePort (443)

diff --git a/docs/default_identities.md b/docs/default_identities.md
@@ -18,5 +18,5 @@ $ infra login $INFRA_SERVER
   Logged in as admin
 ```
 
-## Engine Identity
-This is the identity associated with the default Infra engine created on installation of the Infra server. It is the identity and access key the default engine uses to connect the the Infra server. The default engine access key can be specified in the Helm install, otherwise it is randomly generated.
+## Connector Identity
+This is the identity associated with the default Infra connector created on installation of the Infra server. It is the identity and access key the default connector uses to connect the the Infra server. The default connector access key can be specified in the Helm install, otherwise it is randomly generated.