Skip to content

Commit

Permalink
Update sections
Browse files Browse the repository at this point in the history
  • Loading branch information
shrivara committed Oct 5, 2017
1 parent 1375c9f commit 1e73578
Show file tree
Hide file tree
Showing 13 changed files with 62 additions and 12 deletions.
5 changes: 3 additions & 2 deletions mkdocs.yml
Expand Up @@ -248,9 +248,7 @@ pages:
- Overview: platform/workflow/trigger/overview.md
- Integrations:
- Overview: platform/integration/overview.md
- Amazon ECR (Deprecated): platform/integration/aws-ecr.md
- Amazon ECS: platform/integration/aws-ecs.md
- Amazon Web Services (Deprecated): platform/integration/aws.md
- AWS Keys: platform/integration/aws-keys.md
- Azure: platform/integration/azure.md
- Azure DC/OS: platform/integration/azure-dcos.md
Expand Down Expand Up @@ -282,6 +280,9 @@ pages:
- Quay.io: platform/integration/quay.md
- Slack: platform/integration/slack.md
- SSH Keys: platform/integration/key-ssh.md
- Deprecated:
- Amazon ECR: platform/integration/aws-ecr.md
- Amazon Web Services: platform/integration/aws.md
- Runtime:
- Overview: platform/runtime/overview.md
- Operating System:
Expand Down
47 changes: 47 additions & 0 deletions onebox
@@ -0,0 +1,47 @@
#!/bin/bash -e

readonly COMPONENT=docs
readonly ONEBOX_NAME="$COMPONENT"_onebox
readonly PORT=5555
readonly CYAN="\e[96m"
readonly RESET="\e[39m"

log.info() {
echo -e "$CYAN$@$RESET"
}

log.verbose() {
echo -e $@
}

stop() {
local onebox_exist=$(sudo docker ps -a | grep $ONEBOX_NAME | awk '{print $1}')
if [[ ! -z "$onebox_exist" ]]; then
log.info "Removing $COMPONENT container..."
sudo docker rm -f $ONEBOX_NAME > /dev/null
fi
}

build() {
log.info "Building $COMPONENT image..."
sudo docker build -t shipimg/$COMPONENT .
}

run() {
log.info "Running $COMPONENT..."
sudo docker run --name=$ONEBOX_NAME \
-d -p $PORT:$PORT \
-v $(pwd):/home/shippable/$COMPONENT:rw \
-t shipimg/$COMPONENT \
> /dev/null

log.verbose "Running at http://localhost:$PORT"
}

main() {
stop
build
run
}

main
2 changes: 1 addition & 1 deletion sources/ci/troubleshooting.md
Expand Up @@ -384,7 +384,7 @@ The usual workflow for a pull request is:

---
### How do I specify a region while setting up Amazon EC2 Container Registry (ECR) Integration?
When you set up the [Amazon ECR integration](/platform/integration/aws-ecr/#amazon-ecr-integration), the default region is set to `us-east-1`. You can override the default region by configuring the `shippable.yml` file as shown below.
When you set up the [Amazon ECR integration](/platform/integration/aws-keys), the default region is set to `us-east-1`. You can override the default region by configuring the `shippable.yml` file as shown below.

```
integrations:
Expand Down
2 changes: 1 addition & 1 deletion sources/deploy/amazon-ecs-multiple-containers.md
Expand Up @@ -69,7 +69,7 @@ These files should be committed to your source control. Step 5 of the workflow b
1. Create an account integration for Amazon ECR in your Shippable UI. Instructions to create an integration are here:

* [Adding an account integration](/platform/tutorial/integration/howto-crud-integration/) and .
* [Amazon ECR integration](/platform/integration/aws-ecr/)
* [Amazon ECR integration](/platform/integration/aws-keys/)

Copy the friendly name of the integration, in our case we named it **app_ecr**.

Expand Down
2 changes: 1 addition & 1 deletion sources/deploy/amazon-ecs.md
Expand Up @@ -67,7 +67,7 @@ These files should be committed to your source control. Step 5 of the workflow b
1. Create an account integration for Amazon ECR in your Shippable UI. Instructions to create an integration are here:

* [Adding an account integration](/platform/tutorial/integration/howto-crud-integration/) and .
* [Amazon ECR integration](/platform/integration/aws-ecr/)
* [Amazon ECR integration](/platform/integration/aws-keys/)

Copy the friendly name of the integration.

Expand Down
Expand Up @@ -148,7 +148,7 @@ resources:

* **Required:** Yes.

* **Integrations needed:** [Amazon ECR](/platform/integration/aws-ecr).
* **Integrations needed:** [Amazon ECR](/platform/integration/aws-keys).

The integration defines the AWS key/secret pair that Shippable platform will use to communicate with EB on our behalf. Make sure that the key has appropriate permissions for the different actions required for EB deployments.

Expand Down
Expand Up @@ -132,7 +132,7 @@ resources:

* **Required:** Yes.

* **Integrations needed:** [Amazon ECR](/platform/integration/aws-ecr).
* **Integrations needed:** [Amazon ECR](/platform/integration/aws-keys).

The integration defines the AWS key/secret pair that Shippable platform will use to communicate with EB on our behalf. Make sure that the key has appropriate permissions for the different actions required for EB deployments.

Expand Down
2 changes: 1 addition & 1 deletion sources/deploy/aws-elastic-beanstalk.md
Expand Up @@ -130,7 +130,7 @@ resources:

* **Required:** Yes.

* **Integrations needed:** [Amazon ECR](/platform/integration/aws-ecr).
* **Integrations needed:** [Amazon ECR](/platform/integration/aws-keys).

The integration defines the AWS key/secret pair that Shippable platform will use to communicate with EB on our behalf. Make sure that the key has appropriate permissions for the different actions required for EB deployments.

Expand Down
1 change: 1 addition & 0 deletions sources/platform/integration/aws-ecr.md
@@ -1,6 +1,7 @@
page_main_title: Amazon ECR
main_section: Platform
sub_section: Integrations
sub_sub_section: Deprecated
page_title: Amazon ECR integration

# Amazon ECR integration (Deprecated)
Expand Down
1 change: 1 addition & 0 deletions sources/platform/integration/aws.md
@@ -1,6 +1,7 @@
page_main_title: Amazon ECR
main_section: Platform
sub_section: Integrations
sub_sub_section: Deprecated
page_title: Amazon ECR integration

# AWS integration (Deprecated)
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/integration/overview.md
Expand Up @@ -39,7 +39,7 @@ We are big believers in the concept that secrets need to be separated from scrip

## Supported Docker Registry Integrations

- [AWS ECR](/platform/integration/aws-ecr)
- [AWS ECR](/platform/integration/aws-keys)
- [Docker Hub](/platform/integration/docker-hub)
- [Docker Trusted Registry](/platform/integration/docker-trusted-registry)
- [Docker Private Registry](/platform/integration/docker-private-registry)
Expand Down
4 changes: 2 additions & 2 deletions sources/platform/workflow/job/runsh.md
Expand Up @@ -85,8 +85,8 @@ Here is a list of the tools configured for each integration type:

| Integration Type | Configured Tools|
| ------------------------------------|-------------|
| [AWS](/platform/integration/aws) | [AWS](/platform/runtime/cli/aws) & [Elastic Beanstalk](/platform/runtime/cli/awseb) |
| [AWS ECR](/platform/integration/aws-ecr) | [Docker](/platform/runtime/cli/docker) |
| [AWS](/platform/integration/aws-keys) | [AWS](/platform/runtime/cli/aws) & [Elastic Beanstalk](/platform/runtime/cli/awseb) |
| [AWS ECR](/platform/integration/aws-keys) | [Docker](/platform/runtime/cli/docker) |
| [Azure](/platform/integration/azure) | [Azure](/platform/runtime/cli/azure) |
| [Docker Hub](/platform/integration/docker-hub) | [Docker](/platform/runtime/cli/docker) |
| [Docker Private Registry](/platform/integration/docker-private-registry) | [Docker](/platform/runtime/cli/docker) |
Expand Down
2 changes: 1 addition & 1 deletion sources/platform/workflow/resource/cliconfig.md
Expand Up @@ -23,7 +23,7 @@ resources:
* **`type`** -- is set to `cliConfig`

* **`integration`** -- name of the subscription integration. Currently supported integration types are:
* [Amazon ECR](/platform/integration/aws-ecr)
* [Amazon ECR](/platform/integration/aws-keys)
* [Docker Hub](/platform/integration/docker-hub)
* [Docker Trusted Registry](/platform/integration/docker-trusted-registry)
* [Docker Private Registry](/platform/integration/docker-private-registry)
Expand Down

0 comments on commit 1e73578

Please sign in to comment.