Skip to content

Commit

Permalink
Edits to install from source and install docker topics
Browse files Browse the repository at this point in the history
Copy edits for clarity, consistency, and style guide adherence
  • Loading branch information
ebgitelman authored and haroon-github committed Jan 31, 2024
1 parent 14dee3b commit 3a195c2
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 28 deletions.
34 changes: 17 additions & 17 deletions docs/src/INSTALL-docker.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Running TPA in a Docker container

If you are using a system for which there are no [TPA
If you're using a system for which there are no [TPA
packages](INSTALL.md) available, and it's difficult to run TPA after
[installing from source](INSTALL-repo.md) (for example, because it's not
easy to obtain a working Python 3.9+ interpreter), your last resort may
easy to obtain a working Python 3.9+ interpreter), your last resort might
be to build a Docker image and run TPA inside a Docker container.

Please note that you do not need to run TPA in a Docker container in
order to [deploy to Docker containers](platform-docker.md). It's always
preferable to run TPA directly if you can (even on MacOS X).
You don't need to run TPA in a Docker container
to [deploy to Docker containers](platform-docker.md). It's always
preferable to run TPA directly if you can, even on MacOS X.

## Quickstart
## Quick start

You must have Docker installed and working on your system already.
Make sure you have Docker installed and working on your system.

Run the following commands to clone the tpaexec source repository from Github
and build a new Docker image named `tpa/tpaexec`:
To clone the tpaexec source repository from Github
and build a new Docker image named `tpa/tpaexec`, run the following commands:

```bash
$ git clone ssh://[email protected]/EnterpriseDB/tpa.git
Expand Down Expand Up @@ -47,7 +47,7 @@ $ docker run --platform=linux/amd64 --rm -v ~/clusters:/clusters \
```

You can now run commands like `tpaexec provision /clusters/speedy` at the
container prompt. (When you exit the shell, the container will be removed.)
container prompt. (When you exit the shell, the container is removed.)

If you want to provision Docker containers using TPA, you must also allow
the container to access the Docker control socket on the host:
Expand All @@ -58,16 +58,16 @@ $ docker run --platform=linux/amd64 --rm -v ~/clusters:/clusters \
-it tpa/tpaexec:latest
```

Run `docker ps` within the container to make sure that your connection to the
Run `docker ps` in the container to make sure that your connection to the
host Docker daemon is working.

## Installing Docker

Please consult the
[Docker documentation](https://docs.docker.com) if you need help to
[install Docker](https://docs.docker.com/install) and
[get started](https://docs.docker.com/get-started/) with it.
See the
[Docker documentation](https://docs.docker.com) if you need help
[installing Docker](https://docs.docker.com/install) and
[getting started](https://docs.docker.com/get-started/) with it.

On MacOS X, you can [install "Docker Desktop for
Mac"](https://hub.docker.com/editions/community/docker-ce-desktop-mac/)
On MacOS X, you can [install Docker Desktop for
Mac](https://hub.docker.com/editions/community/docker-ce-desktop-mac/)
and launch Docker from the application menu.
22 changes: 11 additions & 11 deletions docs/src/install_from_source.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Installing from source

You can define a list of extensions to build and install from their Git
repositories by setting `install_from_source` in config.yml:
repositories by setting `install_from_source` in `config.yml`:

```yaml
cluster_vars:
Expand All @@ -21,30 +21,30 @@ cluster_vars:
VAR: value
```
TPA will build and install extensions one by one in the order
listed, so you can build extensions that depend on another (such as
TPA builds and installs extensions one by one in the order
listed. So you can build extensions that depend on another (such as
pglogical and BDR) by mentioning them in the correct order.
Each entry must specify a `name`, `git_repository_url`, and
`git_repository_ref` (default: `master`) to build. You can use
[SSH agent forwarding or an HTTPS username/password](git-credentials.md)
to authenticate to the Git repository; and also set
to authenticate to the Git repository. Also set
`source_directory`, `build_directory`, `build_environment`, and
`build_commands` as shown above.
`build_commands`, as shown in the example.

Run `tpaexec deploy … --skip-tags build-clean` in order to reuse the
build directory when doing repeated deploys. (Otherwise the old build
directory is emptied before starting the build.) You can also configure
To reuse the build directory when doing repeated deploys,
run `tpaexec deploy … --skip-tags build-clean`. Otherwise the old build
directory is emptied before starting the build. You can also configure
[local source directories](configure-source.md#local-source-directories)
to speed up your development builds.

Whenever you run a source build, Postgres will be restarted.
Whenever you run a source build, Postgres is restarted.

## Build dependencies

If you're building from source, TPA will ensure that the basic
If you're building from source, TPA ensures that the basic
Postgres build dependencies are installed. If you need any additional
packages, mention them in [`packages`](packages.md). For example
packages, mention them in [`packages`](packages.md). For example:

```yaml
cluster_vars:
Expand Down

0 comments on commit 3a195c2

Please sign in to comment.