Skip to content

Commit

Permalink
changes post Miki review
Browse files Browse the repository at this point in the history
  • Loading branch information
[email protected] committed Jul 30, 2019
1 parent cba6096 commit 4e95170
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 31 deletions.
2 changes: 1 addition & 1 deletion source/documentation/deploying_apps/index.erb
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ cf add-network-policy PUBLIC_APPNAME --destination-app PRIVATE_APPNAME --protoco

#### Recreate the network policy (optional)

If you are using [version 2.0 of the Cloud Foundry API](https://github.com/cloudfoundry/cloud_controller_ng/tree/master/docs/v2) and a [blue-green deployment tool](https://docs.cloudfoundry.org/devguide/deploy-apps/blue-green.html).
If you are using [version 2.0 of the Cloud Foundry API](https://github.com/cloudfoundry/cloud_controller_ng/tree/master/docs/v2) and a [blue-green deployment tool](https://docs.cloudfoundry.org/devguide/deploy-apps/blue-green.html) to reduce downtime, you must recreate the network policy every time you push your apps.

This is because every time you push your apps, the blue-green deployment creates a new version of the public app, so the network policy will no longer work.

Expand Down
51 changes: 21 additions & 30 deletions source/documentation/getting_started/get_started.erb
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Refer to the Cloud Foundry documentation on [using the Cloud Foundry CLI with a

You can sign in to Cloud Foundry using either your [GOV.UK PaaS account information](get_started.html#get-an-account) or the single sign-on function.

Single sign-on is only available to users within the Government Digital Service (GDS)

### Use your GOV.UK PaaS account

The default method to sign in to Cloud Foundry is to use your [GOV.UK PaaS account](get_started.html#get-an-account) information.
Expand All @@ -56,50 +58,33 @@ The default method to sign in to Cloud Foundry is to use your [GOV.UK PaaS accou

When you have signed in, run `cf` in the command line to see all available commands.

### Use single sign-on

You can sign in to Cloud Foundry using the single sign-on function.

Using single sign-on makes managing your security, joining and leaving processes simpler by reducing the number of passwords or accounts you have to manage.

You must have either a [Google](https://myaccount.google.com/intro) or [Microsoft](https://account.microsoft.com/account) email address to use single sign-on. The email address must be the same as the one you use to sign into your GOV.UK PaaS account.

#### Enable single sign-on
### Use the single sign-on function

1. Sign into the GOV.UK PaaS admin tool for [London](https://admin.london.cloud.service.gov.uk/) or [Ireland](https://admin.cloud.service.gov.uk/).
Single sign-on is only available to users within the Government Digital Service (GDS).

1. Select __Set up Google/Microsoft single sign-on__ and then select __Activate Google/Microsoft single sign-on__.
If you work at GDS, you can enable single sign-on for your account via the GOV.UK PaaS admin tool.

1. Get a URL to generate a temporary authentication code. If your org is hosted in [London](orgs_spaces_users.html#regions), run the following in the command line:
1. Once you have access to SSO and if your org is hosted in London, run the following in the command line:

```
cf login -a api.london.cloud.service.gov.uk --sso
```

If your org is hosted in [Ireland](orgs_spaces_users.html#regions), run:
If your org is hosted in Ireland, run:

```
cf login -a api.cloud.service.gov.uk --sso
```

1. Go to the URL and select __Continue__ under either __Google__ or __Microsoft__.

1. On the __Sign in__ page, enter or select your email address.

1. Enter your password and, if applicable, the 2-step verification code to generate a temporary authentication code.

1. Copy the generated temporary authentication code into the command line.
This will give you a URL where you can generate a temporary authentication code.

When you have signed in, you will see code similar to the following:
1. Go to the URL and select the __Sign in using the GOV.UK PaaS internal account login__ button.

```
API endpoint: https://api.london.cloud.service.gov.uk (API version: 2.136.0)
User: [email protected]
Org: hmrc-prod
Space: sandbox
1. On the __Sign in with Google__ page, select your `@digital.cabinet-office.gov.uk` email address.

```
1. Copy the temporary authentication code into the command line.

When you have signed in, run `cf` in the command line to see all available commands.

## Deploy a test static HTML page using Cloud Foundry API v2

Expand All @@ -109,6 +94,8 @@ The following instructions tell you how to deploy a static HTML page using [v2 o

If you are using [v3 of the Cloud Foundry API](https://github.com/cloudfoundry/cloud_controller_ng/tree/master/docs/v3), refer to the documentation on [deploying a test static HTML page using Cloud Foundry API v3](get_started.html#deploy-a-test-static-html-page-using-cloud-foundry-api-v3).

If you are not sure which version of the Cloud Foundry API to use, contact us at [[email protected]](mailto:[email protected]).

1. To deploy an app, you must select a [target](deploying_apps.html#set-a-target). This is a combination of an [organisation](/orgs_spaces_users.html#organisations) and a [space](/orgs_spaces_users.html#spaces).

All orgs have a sandbox space for you to use when learning about the PaaS. When deploying a test static HTML page, you should target this sandbox space by running:
Expand Down Expand Up @@ -162,14 +149,18 @@ For a production app, you should read the [production checklist](deploying_apps.

You can practice deploying an app by deploying a test static HTML page.

The following instructions tell you how to deploy a static HTML page using [v3 of the Cloud Foundry API](https://github.com/cloudfoundry/cloud_controller_ng/tree/master/docs/v3). This version of the API allows you to push an app with no downtime without needing to use a [blue-green deployment](https://docs.cloudfoundry.org/devguide/deploy-apps/blue-green.html) plugin.

If you are using [v2 of the Cloud Foundry API](https://github.com/cloudfoundry/cloud_controller_ng/tree/master/docs/v2), refer to the documentation on [deploying a test static HTML page using Cloud Foundry API v2](get_started.html#deploy-a-test-static-html-page-using-cloud-foundry-api-v2).
The following instructions tell you how to deploy a static HTML page using [v3 of the Cloud Foundry API](https://github.com/cloudfoundry/cloud_controller_ng/tree/master/docs/v3). This version of the API allows you to push an app with no downtime without needing to use a [blue-green deployment tool](https://docs.cloudfoundry.org/devguide/deploy-apps/blue-green.html).

<br>

<%= warning_text('Cloud Foundry API v3 is still in beta.') %>

Refer to the [Cloud Foundry documentation on the limitations of the v3 API](https://docs.cloudfoundry.org/devguide/deploy-apps/rolling-deploy.html#limitations) for more information.

If you are using [v2 of the Cloud Foundry API](https://github.com/cloudfoundry/cloud_controller_ng/tree/master/docs/v2), refer to the documentation on [deploying a test static HTML page using Cloud Foundry API v2](get_started.html#deploy-a-test-static-html-page-using-cloud-foundry-api-v2).

If you are not sure which version of the Cloud Foundry API to use, contact us at [[email protected]](mailto:[email protected]).

1. To deploy an app, you must select a [target](deploying_apps.html#set-a-target). This is a combination of an [organisation](/orgs_spaces_users.html#organisations) and a [space](/orgs_spaces_users.html#spaces).

All orgs have a sandbox space for you to use when learning about the PaaS. When deploying a test static HTML page, you should target this sandbox space by running:
Expand Down

0 comments on commit 4e95170

Please sign in to comment.