Skip to content
This repository has been archived by the owner on Jun 29, 2022. It is now read-only.

quickstart-docs: Add ssh-agent instructions #325

Merged
merged 1 commit into from
Apr 24, 2020

Conversation

surajssd
Copy link
Member

Fixes: #248

@surajssd surajssd force-pushed the surajssd/add-ssh-agent-doc branch 3 times, most recently from e31254d to e246414 Compare April 22, 2020 15:02
Copy link
Member

@invidian invidian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto also other quickstart guides

docs/quickstarts/aws.md Outdated Show resolved Hide resolved
@@ -121,6 +121,13 @@ guide](../configuration-reference/platforms/aws.md).

### Step 5: Create Lokomotive cluster

Lokoctl uses Terraform behind the scene and it needs SSH access to controller nodes. For SSH to work add at least one SSH private key corresponding to the public keys specified earlier, to your `ssh-agent`.
Copy link
Member

@johananl johananl Apr 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Lokoctl uses Terraform behind the scene and it needs SSH access to controller nodes. For SSH to work add at least one SSH private key corresponding to the public keys specified earlier, to your `ssh-agent`.
Add a private key corresponding to one of the public keys specified in `ssh_pubkeys` to your ssh-agent:
  • IMO it's irrelevant to mention that lokoctl uses Terraform here. All the user needs to know is that they should add an SSH key to ssh-agent.
  • "Lokoctl" should be "lokoctl".
  • "behind the scene" should be "behind the scenes".
  • I like using a colon at the end of an instruction that is followed by a code snippet. We are currently inconsistent there but if we should settle on something, I suggest it be a colon rather than a period.

Signed-off-by: Suraj Deshmukh <suraj@kinvolk.io>
@surajssd surajssd merged commit 848eada into master Apr 24, 2020
@surajssd surajssd deleted the surajssd/add-ssh-agent-doc branch April 24, 2020 09:29
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mention SSH access must work for cluster provisioning to complete
3 participants