Skip to content

Commit

Permalink
basic initialisation of all files
Browse files Browse the repository at this point in the history 
Update installation_docker.md

Update installation_ibm_bluemix_kubernetes.md

Update installation_aws.md

Update installation_google_cloud_kubernetes.md

Update installation_digitalocean.md

Update installation_docker.md

Update installation_digitalocean.md

Update installation_aws.md

Update installation_digitalocean.md

Update installation_google_cloud_kubernetes.md

Update installation_ibm_bluemix_kubernetes.md

Addresses yacy#2 installation docs for cloud providers

Update installation_ibm_bluemix_kubernetes.md

Update installation_ibm_bluemix_kubernetes.md

Update installation_google_cloud_kubernetes.md

Update README.md

final change
  • Loading branch information
@nikhilrayaprolu
nikhilrayaprolu committed Jul 24, 2017
1 parent a999348 commit 3e15066
Show file tree
Hide file tree
Showing 11 changed files with 552 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,13 @@ If you did not start a ftp server, you can find the file in data/mcp-8100/assets
The MCP organises the connection to the remote RabbitMQ server and a ftp server, but if another Grid Service is started, the MCP tells that service to handle the connection to the RabbitMQ and ftp server itself. The MCP can act as such an external service: just start another MCP and it will run at port 8101. Repeat the curl commands as given in the example above, but now use port 8101 to access the MCP. You will see that the second MCP learns from the first MCP to handle the connection by itself.


### How do I install loklak with Docker?
To install loklak with Docker please refer to the [yacy Docker installation readme](/docs/installation_docker.md).

### How do I deploy loklak on Cloud Providers?
To install loklak on Cloud Providers please look documentations at [loklak Cloud installation readme](/docs/).


## Contribute

This is a community project and your contribution is welcome!
Expand Down
55 changes: 55 additions & 0 deletions docs/installation_aws.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
## Installing Yacy on AWS with Docker

1. Sign in to [AWS](https://aws.amazon.com)

2. In the top-right corner, choose a area you want to set up the instance, e.g.: Asia Pacific (Singapore).

3. In the console panel, choose EC2. In EC2 Control Panel, choose key pairs, under Network & Security, and create a new key pair. It will automatically download the private key, and you should do ```chmod 400 YOUR_KEY_NAME``` to prevent other user to access your private key. After that, go back to your dashboard, and click Launch Instance.

4. In Step 1: Choose an Amazon Machine Image, we choose ```Ubuntu Server 14.04 LTS (HVM), SSD Volume Type```.

5. In Step 2: Choose an Instance Type, we choose ```t2.micro```(<strong>Warning:</strong> ```t2.micro``` is not suitable for running Yacy for a long period, and AWS may shut down your instance(block your Internet access on specific port) at any time. ```t2.micro``` instance users are only allow to use <strong>10%</strong> of a single CPU core on average. In our case, Yacy_server uses 30 - 40% on average. Reference: [Burstable Instance](http://aws.amazon.com/ec2/faqs/#burst) Case study: [Real case running Yacy](http://geekinguniverse.com/2016/01/14/dont-use-aws-for-your-web-application/))

6. Then we click ```Configure Instance Details```, do not create a instance yet.

7. Under ```Auto-assign Public IP```, we choose ```Enable```

8. Then we click ```Next: Add Storage```

9. We modify the storage to ```30GiB``` instead of default ```8Gib```

10. Click ```Next``` twice to go to ```Step 6: Configure Security Group```. Under this, we choose ```All TCP``` for type and ```Anywhere``` for source.

11. We are ready to launch, click ```Review and Launch```, if everything is correct, click ```Launch```. It will ask you to choose a key pair, choose the one we just created.

12. We go back to EC2 control panel again. Click on instances on the left hand side. Then choose the instance you just created, and click connect button on top. It will you connect to your EC2 by giving you a example like:
```
ssh -i "yacy.pem" [email protected]
```

13. Once connected, we have to set up docker and add a 4G swapfile to prevent lack of memory:
```
sudo apt-get update
sudo apt-get -y upgrade
sudo fallocate -l 4G /swapfile
sudo chmod 600 /swapfile
sudo mkswap /swapfile
sudo swapon /swapfile
sudo apt-get install linux-image-extra-`uname -r`
sudo apt-key adv --keyserver hkp://pgp.mit.edu:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
echo "deb https://apt.dockerproject.org/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list
sudo apt-get update
sudo apt-get install docker-engine
```
Or, to install docker on newer versions of ubuntu (other distros are not tested) we can just do:
```
sudo apt-get install docker.io
```

14. Once docker is installed, we start our Yacy-server by entering:
```
sudo docker pull nikhilrayaprolu/yacy_grid_mcp
sudo docker run -d -p 8100:8100 -p 443:443 nikhilrayaprolu/yacy_grid_mcp:latest
```

15. Check if Yacy is running on your server, by going to your public DNS, e.g.: ```ec2-54-169-103-75.ap-southeast-1.compute.amazonaws.com```.
55 changes: 55 additions & 0 deletions docs/installation_aws_docker.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
## Installing Yacy on AWS with Docker

1. Sign in to [AWS](https://aws.amazon.com)

2. In the top-right corner, choose a area you want to set up the instance, e.g.: Asia Pacific (Singapore).

3. In the console panel, choose EC2. In EC2 Control Panel, choose key pairs, under Network & Security, and create a new key pair. It will automatically download the private key, and you should do ```chmod 400 YOUR_KEY_NAME``` to prevent other user to access your private key. After that, go back to your dashboard, and click Launch Instance.

4. In Step 1: Choose an Amazon Machine Image, we choose ```Ubuntu Server 14.04 LTS (HVM), SSD Volume Type```.

5. In Step 2: Choose an Instance Type, we choose ```t2.micro```(<strong>Warning:</strong> ```t2.micro``` is not suitable for running Yacy for a long period, and AWS may shut down your instance(block your Internet access on specific port) at any time. ```t2.micro``` instance users are only allow to use <strong>10%</strong> of a single CPU core on average. In our case, Yacy_server uses 30 - 40% on average. Reference: [Burstable Instance](http://aws.amazon.com/ec2/faqs/#burst) Case study: [Real case running Yacy](http://geekinguniverse.com/2016/01/14/dont-use-aws-for-your-web-application/))

6. Then we click ```Configure Instance Details```, do not create a instance yet.

7. Under ```Auto-assign Public IP```, we choose ```Enable```

8. Then we click ```Next: Add Storage```

9. We modify the storage to ```30GiB``` instead of default ```8Gib```

10. Click ```Next``` twice to go to ```Step 6: Configure Security Group```. Under this, we choose ```All TCP``` for type and ```Anywhere``` for source.

11. We are ready to launch, click ```Review and Launch```, if everything is correct, click ```Launch```. It will ask you to choose a key pair, choose the one we just created.

12. We go back to EC2 control panel again. Click on instances on the left hand side. Then choose the instance you just created, and click connect button on top. It will you connect to your EC2 by giving you a example like:
```
ssh -i "yacy.pem" [email protected]
```

13. Once connected, we have to set up docker and add a 4G swapfile to prevent lack of memory:
```
sudo apt-get update
sudo apt-get -y upgrade
sudo fallocate -l 4G /swapfile
sudo chmod 600 /swapfile
sudo mkswap /swapfile
sudo swapon /swapfile
sudo apt-get install linux-image-extra-`uname -r`
sudo apt-key adv --keyserver hkp://pgp.mit.edu:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
echo "deb https://apt.dockerproject.org/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list
sudo apt-get update
sudo apt-get install docker-engine
```
Or, to install docker on newer versions of ubuntu (other distros are not tested) we can just do:
```
sudo apt-get install docker.io
```

14. Once docker is installed, we start our Yacy-server by entering:
```
sudo docker pull nikhilrayaprolu/yacy_grid_mcp
sudo docker run -d -p 8100:8100 -p 443:443 nikhilrayaprolu/yacy_grid_mcp:latest
```

15. Check if Yacy is running on your server, by going to your public DNS, e.g.: ```ec2-54-169-103-75.ap-southeast-1.compute.amazonaws.com```.
47 changes: 47 additions & 0 deletions docs/installation_digitalocean.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## Installing Yacy on DigitalOcean with Docker

[DigitalOcean](https://www.digitalocean.com) - simple cloud hosting, built for developers.

1. Register in [DigitalOcean](https://www.digitalocean.com) and get 10$ credit.

2. Click 'Create droplet' button, choose your droplet image (Docker), size, location and add your SSH keys.

![Droplet image](http://i.imgur.com/wXXvg7W.png)

![SSH keys](http://i.imgur.com/egW1HsV.png)

3. Click 'Create', wait a minute, copy ip of your new droplet and login to it using SSH:
```bash
ssh [email protected]
```

4. Docker is already installed, you can check it using ```docker version``` command. You should see something like this:
```
root@sevazhidkov:~# docker version
Client:
Version: 1.9.1
API version: 1.21
Go version: go1.4.2
Git commit: a34a1d5
Built: Fri Nov 20 13:12:04 UTC 2015
OS/Arch: linux/amd64

Server:
Version: 1.9.1
API version: 1.21
Go version: go1.4.2
Git commit: a34a1d5
Built: Fri Nov 20 13:12:04 UTC 2015
OS/Arch: linux/amd64
```
5. Pull Docker image from [Yacy repository](https://hub.docker.com/r/nikhilrayaprolu/yacy_grid_mcp/) in Docker Hub (it should take about a minute):
```bash
docker pull nikhilrayaprolu/yacy_grid_mcp
```

6. OK, you're ready to run yacy:
```bash
docker run -d -p 8100:8100 -p 443:443 nikhilrayaprolu/yacy_grid_mcp:latest
```
7. Go to your droplet IP using web browser. You should see yacy main page.
47 changes: 47 additions & 0 deletions docs/installation_digitalocean_docker.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## Installing Yacy on DigitalOcean with Docker

[DigitalOcean](https://www.digitalocean.com) - simple cloud hosting, built for developers.

1. Register in [DigitalOcean](https://www.digitalocean.com) and get 10$ credit.

2. Click 'Create droplet' button, choose your droplet image (Docker), size, location and add your SSH keys.

![Droplet image](http://i.imgur.com/wXXvg7W.png)

![SSH keys](http://i.imgur.com/egW1HsV.png)

3. Click 'Create', wait a minute, copy ip of your new droplet and login to it using SSH:
```bash
ssh [email protected]
```

4. Docker is already installed, you can check it using ```docker version``` command. You should see something like this:
```
root@sevazhidkov:~# docker version
Client:
Version: 1.9.1
API version: 1.21
Go version: go1.4.2
Git commit: a34a1d5
Built: Fri Nov 20 13:12:04 UTC 2015
OS/Arch: linux/amd64

Server:
Version: 1.9.1
API version: 1.21
Go version: go1.4.2
Git commit: a34a1d5
Built: Fri Nov 20 13:12:04 UTC 2015
OS/Arch: linux/amd64
```
5. Pull Docker image from [Yacy repository](https://hub.docker.com/r/nikhilrayaprolu/yacy_grid_mcp/) in Docker Hub (it should take about a minute):
```bash
docker pull nikhilrayaprolu/yacy_grid_mcp
```

6. OK, you're ready to run yacy:
```bash
docker run -d -p 8100:8100 -p 443:443 nikhilrayaprolu/yacy_grid_mcp:latest
```
7. Go to your droplet IP using web browser. You should see yacy main page.
43 changes: 43 additions & 0 deletions docs/installation_docker.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Installation of Yacy with Docker

Docker is a way to move applications including the operating system to servers.

## Get a Docker image

Each of the following sections depend on a docker image with a Yacy server inside.
This section shows you how to get such an image.
Some possibilities may be used in the sections but you can may be able to exchange them.

#### Pull a docker image
Pull a docker image from [dockerhub](https://hub.docker.com/r/nikhilrayaprolu/yacy_grid_mcp/).

Type this command in your terminal:
```
docker pull nikhilrayaprolu/yacy_grid_mcp
```

#### Build a docker image on your local machine

1. Type the following commands in terminal
```
sudo apt-get update && sudo apt-get upgrade -y
sudo apt-get install docker.io
sudo docker build https://github.com/yacy/yacy_grid_mcp.git
```

2. You will get a hash from last command. Copy that hash and do...
```
sudo docker tag <IMAGE_HASH> <NAME_FOR_IMAGE>
```

#### Automated build on Cloud using GitHub repository

1. Signup for [Docker](https://cloud.docker.com/)
2. Go to Settings > Linked Accounts & Services.
3. Add your GitHub account and select an access level “Public and Private”, or “Limited Access”.
4. Go to your GitHub account. Settings > Applications.
5. Allow access for Docker Hub Registry.
6. Allow service hook for the repository in its settings > Webhooks & Services.
7. Select a source repository to build image in Docker Hub.
8. Enable rebuilding the Docker image when a commit is pushed to the GitHub repository.
9. Congratulations, you have completed the setup of automated image build.
47 changes: 47 additions & 0 deletions docs/installation_google_cloud_docker.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## Installing Yacy on Google Cloud with Docker


1. Go to [Google Cloud Free Trial](https://cloud.google.com/free-trial/) and sign up. You will get 300 dollars credit for 12 months.


2. Go to the console page: [Console](https://console.cloud.google.com/home)


3. If you don’t have any projects, a page that would guide you on how to start a project will pop up. Give your project a name.


4. In the search bar above on console page, enter 'Compute Engine' and click on ```Compute Engine```.


5. If you have not activated billing for compute engine, click enable billing and choose your account to activate your Compute Engine. Your Google Compute Engine should be activated within a few minutes.


6. Click ```Create instance``` to create an instance. In machine type, choose ```small(1 shared vCPU)```.
Choose whatever zone you like.

In Boot Disk, choose ```Ubuntu 14.04```, and the disk size should be larger than 40GB.
On the bottom of the page, click ```Management, disk, networking, access & security options``` to show more options. Inside of this, click into the tab ```Networking``` and choose ```New static IP``` instead of ```Ephemeral```. Enter a name for your IP. Google will assign a IP for you.
Check the two boxes ```Allow HTTP traffic``` and ```Allow HTTPS traffic```. Finally, click ```Create``` to create an instance. Wait a few minutes for the creation to complete.


7. Once the creation has finished, click ssh below to establish web ssh connections.

8. In the Web Console, enter:

```
sudo apt-get update
sudo apt-get upgrade
sudo apt-get -y install docker.io
sudo fallocate -l 4G /swapfile
sudo chmod 600 /swapfile
sudo mkswap /swapfile
sudo swapon /swapfile
sudo docker pull nikhilrayaprolu/yacy_grid_mcp
```

Once finished, you will get fully working image. You can check if it exists by entering ```sudo docker images```.
Run our server by entering:
```
sudo docker run -d -p 8100:8100 -p 443:443 nikhilrayaprolu/yacy_grid_mcp
```
Enter your assigned HTTP IP address into your browser to check if it is working.
Loading

0 comments on commit 3e15066

Please sign in to comment.