Skip to content

Commit 33783e6

Browse files
authored
fix markdown formatting on /install/server-infrastructure/ (ipfs#1371)
1 parent a8036c5 commit 33783e6

File tree

1 file changed

+34
-13
lines changed

1 file changed

+34
-13
lines changed

docs/install/server-infrastructure.md

Lines changed: 34 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,27 @@ current-ipfs-cluster-version: v1.0.4
88

99
If you want to install IPFS in a server environment and offer IPFS as a service, you should look at [IPFS Cluster](https://cluster.ipfs.io/) as a way to scale your IPFS deployment beyond a single IPFS daemon. IPFS Cluster provides data orchestration across a swarm of IPFS daemons by allocating, replicating, and tracking a global pin-set distributed among multiple peers. This makes it significantly easier to manage multiple IPFS nodes and ensure that data is available across an internal network.
1010

11+
<!-- markdown-link-check-disable -->
1112
@[youtube](-SYDlid7Nqs)
13+
<!-- markdown-link-check-enable-->
1214

13-
::: tip
14-
As a Kubernetes user, you can use a Kubernetes operator for IPFS called [IPFS operator] (https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to easily create and manage clusters consisting of hundreds of peers.
15+
:::tip
16+
As a Kubernetes user, you can use a Kubernetes operator for IPFS called [IPFS operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) to easily create and manage clusters consisting of hundreds of peers.
1517
The IPFS operator is in active development and not yet recommended for production use cases. If the operator is something you would like to include in your infrastructure,
1618
check out the [official documentation](https://ipfs-operator.readthedocs.io/) and [operator source code](https://github.com/redhat-et/ipfs-operator) for instructions and the latest progress.
1719
:::
1820

1921
## Create a local cluster
2022

21-
To see if IPFS Cluster is suitable for your project, follow this quick start guide and spin up a local IPFS Cluster instance. At the end of this guide, you will have a solid understanding of how IPFS Cluster is set up and how to interact with it. If you'd rather create a production-ready cluster, take a look at the [official IPFS Cluster documentation →](https://cluster.ipfs.io/)
23+
To see if IPFS Cluster is suitable for your project, follow this quick start guide and spin up a local IPFS Cluster instance. At the end of this guide, you will have a solid understanding of how IPFS Cluster is set up and how to interact with it. To create a local cluster, complete the prerequisites. Then, follow the procedure.
24+
25+
:::tip
26+
If you'd rather create a production-ready cluster, take a look at the [official IPFS Cluster documentation →](https://cluster.ipfs.io/)
27+
:::
2228

2329
### Prerequisites
2430

25-
You must have both [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/) installed. Check that they're both installed properly by asking for their version:
31+
You must have both [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/) installed. Check that they're both installed properly by checking the version:
2632

2733
```shell
2834
docker version
@@ -39,9 +45,9 @@ docker-compose version
3945
> ...
4046
```
4147

42-
If you're having issues here, head over to the [official Docker documentation to fix your problem ](https://docs.docker.com/)
48+
If you're having issues installing or using Docker or Docker-Compose, see the [official documentation →](https://docs.docker.com/).
4349

44-
### Steps
50+
### Procedure
4551

4652
1. Download the latest `ipfs-cluster-ctl` package from [dist.ipfs.tech](https://dist.ipfs.tech/#ipfs-cluster-ctl):
4753

@@ -67,7 +73,11 @@ If you're having issues here, head over to the [official Docker documentation to
6773
wget https://raw.githubusercontent.com/ipfs/ipfs-cluster/v1.0.4/docker-compose.yml
6874
```
6975

70-
1. Start the cluster using `docker-compose`. You may have to run as root:
76+
1. Start the cluster using `docker-compose`:
77+
78+
:::callout
79+
Depending on your system permissions, you may have to run the command as a root user.
80+
:::
7181

7282
```shell
7383
docker-compose up
@@ -78,23 +88,30 @@ If you're having issues here, head over to the [official Docker documentation to
7888
> Recreating cluster2 ... done
7989
> ...
8090
```
91+
92+
:::warning
8193

82-
You may see some errors like:
94+
Errors such as the following may display:
8395

8496
```shell
8597
cluster2 | 2020-10-27T15:20:15.116Z ERROR ipfshttp error posting to IPFS:Post "http://172.18.0.2:5001/api/v0/pin/ls?type=recursive": dial tcp 172.18.0.2:5001: connect: connection refused
8698
```
8799

88-
You can safely ignore these for now. They're showing because some of the IPFS nodes within the cluster haven't finished spinning up yet. Everything should have loaded after a couple of minutes:
100+
You can safely ignore these errors for now. They're showing because some of the IPFS nodes within the cluster haven't finished spinning up yet. Everything should have loaded after a couple of minutes:
89101

90102
```shell
91103
> ipfs1 | API server listening on /ip4/0.0.0.0/tcp/5001
92104
> ipfs1 | WebUI: http://0.0.0.0:5001/webui
93105
> ipfs1 | Gateway (readonly) server listening on /ip4/0.0.0.0/tcp/8080
94106
> ipfs1 | Daemon is ready
95107
```
108+
:::
96109

97-
1. You can now interact with your cluster. In a new terminal, navigate to the `ipfs-cluster-ctl` directory and list the peers within the cluster:
110+
1. Open a new terminal window.
111+
112+
1. You can now interact with your cluster. In a new terminal window, navigate to the `ipfs-cluster-ctl` directory.
113+
114+
1. List the peers within the cluster:
98115

99116
```shell
100117
./ipfs-cluster-ctl peers ls
@@ -136,9 +153,13 @@ You can safely ignore these for now. They're showing because some of the IPFS no
136153
> > cluster1 : PINNED | 2020-10-27T15:42:39.984842325Z
137154
```
138155

139-
This shows us that `QmdzvHZ...` is pinned across the three IPFS nodes within our cluster.
156+
The output shows that `QmdzvHZ...` is pinned across the three IPFS nodes within our cluster.
157+
158+
1. When you're finished playing around, kill the cluster:
140159
141-
1. When you're finished playing around, kill the cluster. You may have to run this as root:
160+
:::callout
161+
Depending on your system permissions, you may have to run the command as a root user.
162+
:::
142163
143164
```shell
144165
docker-compose kill
@@ -151,7 +172,7 @@ This shows us that `QmdzvHZ...` is pinned across the three IPFS nodes within our
151172
> Killing ipfs2 ... done
152173
```
153174
154-
The terminal running the `ipfs-cluster-ctl` daemon will close any open connections:
175+
The terminal running the `ipfs-cluster-ctl` daemon will close any open connections:
155176
156177
```shell
157178
> ...

0 commit comments

Comments
 (0)