Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding quickstart #27

Merged
merged 1 commit into from
Jul 6, 2020
Merged

adding quickstart #27

merged 1 commit into from
Jul 6, 2020

Conversation

lamek
Copy link
Contributor

@lamek lamek commented Jun 24, 2020

Updated the quickstart guide from here - https://github.com/jeremyeder/moa-docs/blob/install/INSTALL.md

2 questions:

  1. Do we want to recommend using the latest version of moactl?
  2. Can we provide info on how much quota is needed (and how to change this in AWS) in order to spin up a cluster?

I have a handful of other things I need to test, and a few placeholder docs for troubleshooting and permissions.

@lamek
Copy link
Contributor Author

lamek commented Jun 24, 2020

@jeremyeder @vkareh @jharrington22 PTAL. 2 questions specifically I could use help on.

Copy link
Member

@vkareh vkareh left a comment

Choose a reason for hiding this comment

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

This is looking good! Thanks :)

moa-quickstart.md Outdated Show resolved Hide resolved
moa-quickstart.md Outdated Show resolved Hide resolved
moa-quickstart.md Outdated Show resolved Hide resolved
moa-quickstart.md Outdated Show resolved Hide resolved
Run the following command to create your cluster:

```
$ time moactl create cluster --name=rh-moa-test1
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we want to print out the output of moactl create cluster --help here, as it gives a bunch of options for the cluster

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm 50/50 on this. I think for the hackday audience it might be nice to offer a quick command they can copy/paste, but call out that they can run moactl create cluster --help to see all of their available options.

moa-quickstart.md Outdated Show resolved Hide resolved
install-troubleshooting.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
moa-quickstart.md Outdated Show resolved Hide resolved
moa-quickstart.md Outdated Show resolved Hide resolved
moa-quickstart.md Outdated Show resolved Hide resolved
moa-quickstart.md Outdated Show resolved Hide resolved
@lamek lamek force-pushed the update-quickstart branch from 2c2262d to e5a26bb Compare June 28, 2020 20:41
README.md Outdated Show resolved Hide resolved
$ moactl list idps --cluster rh-moa-test-cluster1
NAME TYPE AUTH URL
github-1 GitHub https://oauth-openshift.apps.rh-moa-test-cluster1.j9n4.s1.devshift.org/oauth2callback/github-1
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Here let's have the user try to login to the console with their github credentials before moving on to creating a dedicated-admin.

Copy link
Contributor

Choose a reason for hiding this comment

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

And maybe a screenshot or 2 will help.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I moved the content but leaving this thread open so I remember to add some screenshots.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved

Use "moactl [command] --help" for more information about a command.
```

Copy link
Contributor

Choose a reason for hiding this comment

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

add a blurb about using moactl bash completion here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added some text below. This did not work for me on a Mac. We should add another oneliner for mac.

@lamek lamek force-pushed the update-quickstart branch from e5a26bb to ec2ba8f Compare July 2, 2020 21:08

Complete the following prerequisites before creating your MOA cluster.

### Select an AWS account to use
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jeremyeder @jharrington22 @vkareh I added a new section here based on the customer cloud subscription doc. Appreciate feedback on how much of this info will be useful for the customer to know.

I think we still have not yet addressed the use case of a customer with an existing SCP that in some way limits the use of moa. I recommended not having an SCP at all.

@vkareh vkareh merged commit f89390f into openshift:master Jul 6, 2020
Comment on lines +29 to +34
Next, you must not have a Service Control Policy applied to the AWS account you plan to use. As part of the cluster creation process, moactl will perform the following actions:

- Create an osdCcsAdmin IAM user:
- This user will have Programmatic access enabled.
- This user will have the AdministratorAccess policy attached to it.
- This user will leverage the IAM credentials you provide when configuring the AWS cli in the next section.
Copy link
Contributor

Choose a reason for hiding this comment

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

@lamek it is OK to have an SCP applied to the AWS account you wish to use. It must be either allow all or have the following policy applied or equivalent permissions https://www.openshift.com/dedicated/ccs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jeremyeder @vkareh @jharrington22 PTAL. 2 questions specifically I could use help on.

RE Np. 2 - We don't have a publicly listed set of required quota. We could add a feature for moactl to print what it is validating? Thoughts?

I think this would be very helpful. Depending on the amount of work, it might be worth waiting to see how many people stumble on this.

@jharrington22
Copy link
Contributor

jharrington22 commented Jul 6, 2020

@jeremyeder @vkareh @jharrington22 PTAL. 2 questions specifically I could use help on.

RE Np. 2 - We don't have a publicly listed set of required quota. We could add a feature for moactl to print what it is validating? Thoughts?

@vkareh
Copy link
Member

vkareh commented Jul 6, 2020

@jeremyeder @vkareh @jharrington22 PTAL. 2 questions specifically I could use help on.

RE Np. 2 - We don't have a publicly listed set of required quota. We could add a feature for moactl to print what it is validating? Thoughts?

you mean a more verbose output for moactl verify quota?

@jharrington22
Copy link
Contributor

jharrington22 commented Jul 6, 2020

@vkareh maybe moactl list quota or moactl verify quota --list ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants