Skip to content

Commit 5ebff63

Browse files
authored
[DT-1048] Remove outdated Brew instructions (#2732)
1 parent 40201be commit 5ebff63

File tree

2 files changed

+2
-26
lines changed

2 files changed

+2
-26
lines changed

docs/Brewfile

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
brew "git"
2-
brew "git-secrets"
32
brew "jq"
43
brew "volta"
54
cask "docker"
65
cask "google-cloud-sdk"
76
cask "intellij-idea" # comment this line and uncomment the next line
87
# cask "intellij-idea-ce" # if you want to install the community edition
9-
cask "postgres-unofficial"

docs/getting-started.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ Ensure that you have access to the required team resources. If you encounter a p
3333
DUOS and [Terra](https://terra.bio/) use [Sam](https://github.com/broadinstitute/sam) to abstract identity and access management. To gain access to these services, first create a non-Broad email address through Gmail. This email address will specifically be used for development purposes in our non-prod environments. Next, to register as a new user, click the `Sign in with Google` button in each of the environments with the newly created email address and follow the prompts:
3434

3535
- [Dev](https://bvdp-saturn-dev.appspot.com/)
36-
- [Alpha](https://bvdp-saturn-alpha.appspot.com/)
3736
- [Staging](https://bvdp-saturn-staging.appspot.com/)
3837

3938
For [production](https://app.terra.bio/), you will need to register using a `firecloud.org` email. In order to get an account, you must become suitable, which requires following [these steps](https://docs.google.com/document/d/1DRftlTe-9Q4H-R0jxanVojvyNn1IzbdIOhNKiIj9IpI/edit?usp=sharing).
@@ -53,29 +52,18 @@ brew bundle --no-lock install
5352
Running the `brew` command above will install the following tools:
5453

5554
1. [Git](https://git-scm.com/) is a version control tool for tracking changes in projects and code.
56-
2. [git-secrets](https://github.com/awslabs/git-secrets) prevents developers from committing passwords and secrets to git.
5755
3. [jq](https://stedolan.github.io/jq/) is a command line JSON processing tool.
5856
4. [Docker](https://www.docker.com/) is a tool to deliver software in packages called containers. Docker for MacOS also includes [Kubernetes](https://kubernetes.io/), which deploys groups of containers together in clusters.
59-
5. [Vault](https://www.vaultproject.io/) is an encrypted database used to store many of the team's secrets such as keys and passwords.
6057
6. [Volta](https://volta.sh/) is a tool to manage installations of [`nodejs`](https://nodejs.org/en/) and its dependencies. The DUOS user interface is built using `nodejs`.
6158
7. [Google Cloud SDK](https://cloud.google.com/sdk) is a command-line interface to Google Cloud services. Once it is installed, you'll need to allow auth access and configure Docker to connect to the appropriate Google Cloud endpoint when necessary, which is done with the configuration below.
6259
8. [IntelliJ IDEA](https://www.jetbrains.com/idea/) is an integrated development environment (IDE) for Java. There are two versions available: **Ultimate** (paid) and **Community** (open-source). We recommend the Ultimate Edition to Broad employees for its database navigation capabilities. Alternatively, the Community Edition has all the features needed for development, and this version can be installed by switching `intellij-idea` with `intellij-idea-ce` in the Brewfile.
63-
9. [Postgres](https://www.postgresql.org/) is an advanced open-source database.
6460

6561
Unfortunately, some manual configuration is also necessary:
6662

6763
```
68-
# configure vault
69-
export VAULT_ADDR=https://clotho.broadinstitute.org:8200
70-
7164
# launch docker desktop - this installs docker in /usr/local/bin
7265
open -a docker
7366
74-
# launch postgres.app
75-
# 1. click the sidebar icon (bottom left-hand corner) and then click the plus sign
76-
# 2. name the new server, making sure to select version 11 and then initialize it
77-
open -a postgres
78-
7967
# configure google-cloud-sdk
8068
gcloud auth login
8169
gcloud auth application-default login
@@ -88,7 +76,7 @@ volta setup && volta install ${NODE_VERSION}
8876

8977
## 6. Create GitHub token
9078

91-
The GitHub token verifies team permissions. This token is necessary for the next step, [Login to Vault](#9-login-to-vault). To create a token:
79+
The GitHub token verifies team permissions. To create a token:
9280

9381
1. Go to the [GitHub Personal Access Token](https://github.com/settings/tokens) page and click **Generate new token**.
9482
2. Give the token a descriptive name, **only** give it the following two scopes and then click **Generate token**.
@@ -101,17 +89,7 @@ GITHUB_TOKEN=<<GITHUB TOKEN VALUE>>
10189
echo $GITHUB_TOKEN > ~/.github-token
10290
```
10391

104-
## 7. Login to Vault
105-
106-
Vault access tokens can be obtained using the GitHub token from earlier as follows:
107-
108-
```
109-
vault login -method=github token=$(cat ~/.github-token)
110-
```
111-
112-
> Vault access tokens expire after 30 days, so if you get a `403` error trying to use `vault`, re-run the `vault login` command to refresh your access token.
113-
114-
## 8. Code Checkout
92+
## 7. Code Checkout
11593

11694
> It may be useful to create a folder for Broad projects in your home directory.
11795

0 commit comments

Comments
 (0)