Skip to content

Commit

Permalink
update config file and website install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Zahi Ben Shabat committed Aug 28, 2024
1 parent 8940648 commit 6722487
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 27 deletions.
18 changes: 7 additions & 11 deletions config/sample.env
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
# --- BEGIN CONFIGURATIONS NEEDED BEFORE EXECUTING THE PLATFORM IaC ---------

# 12 digit AWS account ID to deploy Backstage/OPA platform resources to
# Example AWS_ACCOUNT_ID=0000000000
AWS_ACCOUNT_ID="TODO"

# by deployment scripts.
Expand All @@ -18,28 +19,23 @@ OPA_PREFIX="opa"

# AWS region used as the default for AWS CLI commands
# Example: us-east-1
AWS_DEFAULT_REGION="us-east-1"
AWS_DEFAULT_REGION=us-east-1

# The version of GitLab to install into an EC2 instance
# Comment out this value or leave it blank to get the latest version.
# Note that the latest version may not have been tested. Refer to the documentation to verify the latest tested version
# https://opaonaws.io/docs/getting-started/deploy-the-platform
GITLAB_VERSION=17.2.2

# The AMI for the GitLab runner EC2
# Note that AMIs are region-specific
# Example us-east-1 AMI: ami-0557a15b87f6559cf
GITLAB_RUNNER_AMI="TODO"

# Automation key Example - eZv5ofW3KnR3kVabMW4ZcDNLPl9VmMW
# Automation key Example - AUTOMATION_KEY=eZv5ofW3KnR3kVabMW4ZcDNLPl9VmMW
AUTOMATION_KEY="TODO"

# The name of the secret that contains Okta info
OKTA_SECRET_NAME="opa-okta-secrets"


# Route 53 hosted zone for the Backstage/OPA platform deployment
# Example: mycompany.com
# Example: R53_HOSTED_ZONE_NAME=mycompany.com
R53_HOSTED_ZONE_NAME="TODO"

# Comma separated list of IPv4 CIDR ranges to allow requests to Backstage/GitLab load balancers
Expand Down Expand Up @@ -102,16 +98,16 @@ POSTGRES_PASSWORD="example"
# When using the GitLab instance provisioned by the platform solution, then
# this value will be the same as the R53_HOSTED_ZONE_NAME prefixed with 'git.'
# Example: git.mycompany.com
GITLAB_HOSTNAME="TODO"
GITHUB_HOSTNAME="github.com"
# The GitLab host name (without any protocol)
GITLAB_HOSTNAME="git.example.com"

GITLAB_URL="https://git.example.comv"

# The name of the secret that contains GitLab info
GITLAB_SECRET_NAME="opa-admin-gitlab-secrets"
GITLAB_SECRET_NAME=opa-admin-gitlab-secrets
# The name of the secret that contains GitHub info
GITHUB_SECRET_NAME="opa-admin-github-secrets"
GITHUB_SECRET_NAME=opa-admin-github-secrets

# toggle if create environment provisioning role is required
CREATE_ENV_PROVISIONING_ROLE="true"
Expand Down
16 changes: 0 additions & 16 deletions website/docs/getting-started/deploy-the-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,6 @@ Prior to installing the Harmonix solution platform, you will need to ensure that

* **AWS Account ID and region** - The solution will be installed into an AWS account and region. You will need the 12-digit account ID and must be able to log into the account with sufficient permissions to provision infrastructure resources.

* **GitLab Community Edition EC2 AMI id** - The solution will install a small GitLab instance where application source code will be stored. The AWS Marketplace provides a **free**, community edition of GitLab used by the solution.
* You will need to subscribe to the AWS Marketplace offering. Search for "GitLab Community Edition" by GitLab or use a direct link: https://aws.amazon.com/marketplace/pp/prodview-w6ykryurkesjq
* Once your account is subscribed to the GitLab CE Marketplace offering, save the EC2 AMI for the appropriate region from the "Launch new instance" page as shown in the image below (_do not actually launch an instance as this will be done for you during installation_).
![Marketplace GitLab EC2 AMI](/img/gitlab_marketplace.png) <!-- <img src={require('/img/gitlab_marketplace.png').default} alt="Marketplace Gitlab EC2 AMI" width="60%" height="60%" /> -->
Alternatively, you can query for the AMI using the AWS CLI (substitute the appropriate region value for the `--region` option):
```sh

aws ec2 describe-images --owners "aws-marketplace" --filters "Name=name,Values=*GitLab CE 16.8.1*" --query 'Images[].[ImageId]' --region <AWS_REGION> --output text
```

* **GitLab Runner image** - The solution will set up an EC2 instance as a GitLab Runner to execute GitLab CI/CD pipelines. The Amazon-provided "Jammy" image will be used for the runner image. Save the EC2 AMI for the appropriate region for this AMI. The following AMI command will return the appropriate image id. Replace the value for "--region" to reflect your target region:
```sh

aws ec2 describe-images --owners "amazon" --filters "Name=name,Values=*ubuntu-jammy-22.04-amd64-server-20230208*" --query 'Images[].[ImageId]' --region <AWS_REGION> --output text
```

* **Route 53 Hosted Zone** - The solution will ensure secure communcations and set up a certificate for your defined domain. Ensure that a public hosted zone is set up in your account. See the AWS documentation for [creating a public hosted zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/CreatingHostedZone.html)

* **Okta authentication** - The solution uses Okta and RoadieHQ Backstage plugins for authentication of users and groups. You will need a client id, client secret, and API key for configuration of the solution. If you wish to use Okta for authentication and do not have an existing account, you can [sign up a free *Workforce Identity Cloud* developer account](https://developer.okta.com/signup/).
Expand Down

0 comments on commit 6722487

Please sign in to comment.