Adds missing steps for installation on MacOS X #791

kevprice83 · 2019-05-08T13:51:38Z

What this PR does / why we need it:

Some steps are missing in the installation guide for MacOS.

Which issue(s) this PR fixes

Martouta · 2019-05-08T15:21:41Z

INSTALL.md

@@ -176,3 +184,16 @@ Start up the rails server by running the following command:
 $ UNICORN_WORKERS=2 rails server -b 0.0.0.0 # Runs the server, available at localhost:3000
 ```
 > The number of unicorn workers is variable and sometimes it will need more than 2. In case the server is slow or start suffering from timeouts, try restarting porta with a higher number like 8.
+
+Set the domain for the Master, Provider & Developer portals via the rails console. Whichever hostname being used for the local machine should be the value set for each attribute (the following domain names are just examples and updating the */etc/hosts* file is also required):


This is not necessary at all. It creates the domains by default. It is still ok to do it and mention it somewhere if you want, but this is not part of the installation so it shouldn't be in INSTALL.md, and anyway it is important to say clearly that this step is optional.

ah okay yes it should be optional, it creates the domains but they cannot be used, they are just example.com, is there another README where this step would be more appropriate?

@kevprice83 What do you mean that they can't be used? 😱 They should be able to be used. I can use them:

Tenant

Master

Well the accounts were created in my case with the following domains: master-admin.example.com, provider-admin.example.com, provider.example.com so these were obviously never going to work unless they are added to the /etc/hosts. Did you pass a param when starting up the rails server to add .lvh.me? @Martouta

The .lvh.me resolves itself and all its subdomains to 127.0.0.1. So you don't need to setup your own DNS or change your /etc/hosts.

Didier is right 😄 And anyway you can change the example.com anyway by an ENV THREESCALE_SUPERDOMAIN or making a config/settings.yml with this with the default you want:

porta/config/examples/settings.yml

Line 2 in 04e65ef

superdomain: <%= superdomain = ENV.fetch('THREESCALE_SUPERDOMAIN', 'example.com') %>

And the .lvh.me is because we don't want to resolve to real URLs in development and we used to use .dev but we had problems with it for an update of Chrome so now we use this one, as you can customise as well if you want to (but only if you know well what you are doing):

porta/config/examples/settings.yml

Line 41 in 04e65ef

dev_gtld: <%= ENV.fetch('DEV_GTLD', 'lvh.me') %>

Understood @Martouta @didierofrivia I'll make the change, I didn't know this.

As long as you have internet or a DNS server setup correctly with .lvh.me pointing to 127.0.0.1

But I think that is out of topic for the README, we can do a Pro-tip
What would be good is to begin to have wiki page for those pro-tips instead of files.

Yeah I just wasn't aware that lvh.me was a standard DNS entry mapped back to 127.0.0.1 I think this could be fine in another wiki or README I suppose.

Martouta · 2019-05-08T15:23:31Z

INSTALL.md

+Run [NPM](https://www.npmjs.com/) to install all the required Node modules:
+
+```bash
+npm install


Great! Thanks 👍

Martouta

I am not sure if that note at the end is ideal but I guess it won't hurt 😄
LGTM 👍

Martouta · 2019-05-08T16:24:11Z

Preferably wait for one more review if it comes in few days 😝

hallelujah · 2019-05-09T06:31:59Z

INSTALL.md

@@ -176,3 +184,5 @@ Start up the rails server by running the following command:
 $ UNICORN_WORKERS=2 rails server -b 0.0.0.0 # Runs the server, available at localhost:3000
 ```
 > The number of unicorn workers is variable and sometimes it will need more than 2. In case the server is slow or start suffering from timeouts, try restarting porta with a higher number like 8.
+
+**NOTE:** 3scale porta will resolve all subdomains locally through use of `.lvh.me` domain extension.


Probably add an example.

When you seed the application with rake db:setup it will create the provider account and the master account, respectively accessible through, http://provider-admin.example.com.lvh.me:3000 and http://master-account.example.com.lvh.me:3000

Maybe this note would be better right after the db:setup command, and mentioning also that password should wrote down at that moment.

Yeah that's a good point @josemigallas as I did have to reset password having missed that output on the terminal. I can also add an example of the domains which are seeded @hallelujah

Martouta · 2019-05-09T15:59:45Z

Please also sign all the commits the next time you push 😄

codecov · 2019-05-10T10:03:05Z

Codecov Report

Merging #791 into master will decrease coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #791      +/-   ##
==========================================
- Coverage    92.9%   92.87%   -0.03%     
==========================================
  Files        2414     2397      -17     
  Lines       78251    78057     -194     
==========================================
- Hits        72696    72499     -197     
- Misses       5555     5558       +3

Impacted Files	Coverage Δ
lib/tasks/multitenant/tenants.rake	`53.84% <0%> (-23.08%)`	⬇️
app/lib/features/account_deletion_config.rb	`93.33% <0%> (-6.67%)`	⬇️
app/representers/usage_limit_representer.rb	`93.75% <0%> (-0.37%)`	⬇️
app/models/user.rb	`95.05% <0%> (-0.06%)`	⬇️
test/unit/user_test.rb	`98.83% <0%> (-0.02%)`	⬇️
.../find_and_delete_accounts_scheduled_worker_test.rb	`100% <0%> (ø)`	⬆️
test/unit/signup/result_test.rb	`100% <0%> (ø)`	⬆️
config/initializers/features.rb	`100% <0%> (ø)`	⬆️
...rkers/find_and_delete_scheduled_accounts_worker.rb	`100% <0%> (ø)`	⬆️
app/lib/event_store/repository.rb	`100% <0%> (ø)`	⬆️
... and 30 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 05adee1...23d80ca. Read the comment docs.

kevprice83 · 2019-05-10T10:11:29Z

@Martouta I signed my latest commit but not sure of how to sign all the existing commits, is that still necessary for this PR?

didierofrivia · 2019-05-10T10:26:08Z

@kevprice83 all commits must be signed.

kevprice83 · 2019-05-10T12:28:37Z

@didierofrivia all the commits are signed correctly now right?

Martouta

👍 💪

Martouta reviewed May 8, 2019

View reviewed changes

INSTALL.md

Run [NPM](https://www.npmjs.com/) to install all the required Node modules:

```bash

npm install

Copy link

Contributor

Martouta May 8, 2019

Choose a reason for hiding this comment

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

Great! Thanks 👍

Martouta requested review from josemigallas, didierofrivia, thomasmaas and a team May 8, 2019 15:23

Martouta assigned kevprice83 May 8, 2019

Martouta previously approved these changes May 8, 2019

View reviewed changes

Martouta requested a review from a team May 8, 2019 16:23

hallelujah reviewed May 9, 2019

View reviewed changes

kevprice83 changed the title ~~adds missing steps for installation on MacOS X~~ [WIP] adds missing steps for installation on MacOS X May 9, 2019

kevprice83 changed the title ~~[WIP] adds missing steps for installation on MacOS X~~ WIP adds missing steps for installation on MacOS X May 9, 2019

kevprice83 dismissed Martouta’s stale review via 77a15de May 10, 2019 10:02

kevprice83 changed the title ~~WIP adds missing steps for installation on MacOS X~~ Adds missing steps for installation on MacOS X May 10, 2019

kevprice83 force-pushed the update-install-guide-THREESCALE-2489 branch from 77a15de to ba691fd Compare May 10, 2019 12:05

kevprice83 added 4 commits May 10, 2019 14:27

adds missing steps for installation on MacOS X

4200fb1

removes unnecessary step and adds note

2c8ffaa

adds note about generated credentials

3e206f1

fixes typos

23d80ca

kevprice83 force-pushed the update-install-guide-THREESCALE-2489 branch from ba691fd to 23d80ca Compare May 10, 2019 12:27

Martouta approved these changes May 10, 2019

View reviewed changes

Martouta requested a review from a team May 10, 2019 12:43

guicassolato approved these changes May 10, 2019

View reviewed changes

hallelujah approved these changes May 10, 2019

View reviewed changes

hallelujah merged commit 002bf69 into master May 10, 2019

hallelujah deleted the update-install-guide-THREESCALE-2489 branch May 10, 2019 13:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds missing steps for installation on MacOS X #791

Adds missing steps for installation on MacOS X #791

kevprice83 commented May 8, 2019

Martouta May 8, 2019

kevprice83 May 8, 2019

Martouta May 8, 2019

kevprice83 May 8, 2019

didierofrivia May 8, 2019

Martouta May 8, 2019 •

edited

kevprice83 May 8, 2019

hallelujah May 9, 2019

kevprice83 May 9, 2019

Martouta May 8, 2019

Martouta left a comment

Martouta commented May 8, 2019

hallelujah May 9, 2019

josemigallas May 9, 2019

kevprice83 May 9, 2019

Martouta commented May 9, 2019

codecov bot commented May 10, 2019 •

edited

kevprice83 commented May 10, 2019

didierofrivia commented May 10, 2019

kevprice83 commented May 10, 2019

Martouta left a comment

Adds missing steps for installation on MacOS X #791

Adds missing steps for installation on MacOS X #791

Conversation

kevprice83 commented May 8, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tenant

Master

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Martouta May 8, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Martouta left a comment

Choose a reason for hiding this comment

Martouta commented May 8, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Martouta commented May 9, 2019

codecov bot commented May 10, 2019 • edited

Codecov Report

kevprice83 commented May 10, 2019

didierofrivia commented May 10, 2019

kevprice83 commented May 10, 2019

Martouta left a comment

Choose a reason for hiding this comment

Martouta May 8, 2019 •

edited

codecov bot commented May 10, 2019 •

edited