Skip to content

Commit

Permalink
feat(images): add support for LND v0.10.0 and c-lightning v0.8.2
Browse files Browse the repository at this point in the history
  • Loading branch information
jamaljsr committed May 1, 2020
1 parent 5ef8440 commit 6df87c8
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 13 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -36,8 +36,8 @@ With Polar you can:

Supported Network Node Versions:

- LND v0.9.1, v0.9.0, v0.8.2, v0.8.0 & v0.7.1
- c-lightning v0.8.1 & v0.8.0
- LND v0.10.0, v0.9.1, v0.9.0, v0.8.2, v0.8.0 & v0.7.1
- c-lightning v0.8.2, v0.8.1 & v0.8.0
- Eclair v0.3.3
- Bitcoin Core v0.19.1, v0.19.0.1 & v0.18.1

Expand Down
7 changes: 6 additions & 1 deletion docker/README.md
Expand Up @@ -31,6 +31,7 @@ $ docker push polarlightning/bitcoind:<version>

### Tags

- `0.10.0-beta` ([lnd/Dockerfile](https://github.com/jamaljsr/polar/blob/master/docker/lnd/Dockerfile))
- `0.9.1-beta` ([lnd/Dockerfile](https://github.com/jamaljsr/polar/blob/master/docker/lnd/Dockerfile))
- `0.9.0-beta` ([lnd/Dockerfile](https://github.com/jamaljsr/polar/blob/master/docker/lnd/Dockerfile))
- `0.8.2-beta` ([lnd/Dockerfile](https://github.com/jamaljsr/polar/blob/master/docker/lnd/Dockerfile))
Expand All @@ -56,6 +57,7 @@ $ docker push polarlightning/lnd:<version>

### Tags

- `0.8.2` ([clightning/Dockerfile](https://github.com/jamaljsr/polar/blob/master/docker/clightning/Dockerfile))
- `0.8.1` ([clightning/Dockerfile](https://github.com/jamaljsr/polar/blob/master/docker/clightning/Dockerfile))
- `0.8.0` ([clightning/Dockerfile](https://github.com/jamaljsr/polar/blob/master/docker/clightning/Dockerfile))

Expand Down Expand Up @@ -97,16 +99,19 @@ $ docker push polarlightning/eclair:<version>

# Out-of-Band Image Updates

> Note: These steps can only be performed by developers with commit access to this GitHub repo and push access to the Docker Hub repo
These docker images can be updated in-between Polar releases. This allows developers to use the latest Bitcoin & Lightning versions shortly after they are released, without needing to download and install a new version of Polar.

To make new docker image versions available:

1. Build the new docker image using the commands above
1. Push the image to Docker Hub
1. Update the [`/docker/nodes.json`](https://github.com/jamaljsr/polar/blob/master/docker/nodes.json) file
1. Update the [`docker/nodes.json`](https://github.com/jamaljsr/polar/blob/master/docker/nodes.json) file
- add the new version to the `versions` array of the associated implementation
- update the `latest` property of the implementation if necessary
- increment the root-level `version` number by `1`
1. Update the [`src/utils/constants.ts`](https://github.com/jamaljsr/polar/blob/master/src/utils/constants.ts) file

Once the updated `nodes.json` file is committed to master, the new images can be used in Polar by following these steps:

Expand Down
18 changes: 13 additions & 5 deletions docker/nodes.json
@@ -1,10 +1,18 @@
{
"version": 5,
"version": 6,
"images": {
"LND": {
"latest": "0.9.1-beta",
"versions": ["0.9.1-beta", "0.9.0-beta", "0.8.2-beta", "0.8.0-beta", "0.7.1-beta"],
"latest": "0.10.0-beta",
"versions": [
"0.10.0-beta",
"0.9.1-beta",
"0.9.0-beta",
"0.8.2-beta",
"0.8.0-beta",
"0.7.1-beta"
],
"compatibility": {
"0.10.0-beta": "0.19.1",
"0.9.1-beta": "0.19.1",
"0.9.0-beta": "0.19.1",
"0.8.2-beta": "0.19.1",
Expand All @@ -13,8 +21,8 @@
}
},
"c-lightning": {
"latest": "0.8.1",
"versions": ["0.8.1", "0.8.0"]
"latest": "0.8.2",
"versions": ["0.8.2", "0.8.1", "0.8.0"]
},
"eclair": {
"latest": "",
Expand Down
18 changes: 13 additions & 5 deletions src/utils/constants.ts
Expand Up @@ -211,14 +211,22 @@ export const REPO_STATE_URL =
* are pushed to Docker Hub, this list should be updated along with the /docker/nodes.json file.
*/
export const defaultRepoState: DockerRepoState = {
version: 5,
version: 6,
images: {
LND: {
latest: '0.9.1-beta',
versions: ['0.9.1-beta', '0.9.0-beta', '0.8.2-beta', '0.8.0-beta', '0.7.1-beta'],
latest: '0.10.0-beta',
versions: [
'0.10.0-beta',
'0.9.1-beta',
'0.9.0-beta',
'0.8.2-beta',
'0.8.0-beta',
'0.7.1-beta',
],
// not all LND versions are compatible with all bitcoind versions.
// this mapping specifies the highest compatible bitcoind for each LND version
compatibility: {
'0.10.0-beta': '0.19.1',
'0.9.1-beta': '0.19.1',
'0.9.0-beta': '0.19.1',
'0.8.2-beta': '0.19.1',
Expand All @@ -227,8 +235,8 @@ export const defaultRepoState: DockerRepoState = {
},
},
'c-lightning': {
latest: '0.8.1',
versions: ['0.8.1', '0.8.0'],
latest: '0.8.2',
versions: ['0.8.2', '0.8.1', '0.8.0'],
},
eclair: {
latest: '0.3.3',
Expand Down

0 comments on commit 6df87c8

Please sign in to comment.