search

BinPar / bi-mupx

MIT License
3 stars 0 forks source link

readme

Extended mupx

This package is the https://github.com/arunoda/meteor-up-legacy#mupx package with some modifications for our own use. Use under your own risk.

Errores conocidos y posibles soluciones

https://github.com/BinPar/bi-mupx/blob/master/docs/troubleshoot.md

Cómo hacer un deploy correctamente

Como convenio en BinPar hemos adoptado que los archivos necesarios para realizar los deploys van en directorios nombrados ".deploy". En el caso de requerir varios deploys a instancias distintas los nombraremos ".deploy-" (i.e.: ".deploy-beta", ".deploy-prod" ).

Lo primero que debéis hacer es aseguraros de tener la última versión de @binpar/mupx

sudo npm install -g @binpar/mupx

Antes de realizar ningún setup

Asegurarse de que el dominio que vamos a usar está apuntando al servidor en el que vamos a hacer el deploy.

Deploy meteor

Dentro de los directorios de deploy tendremos dos archivos el mup.json y el settings.json.

El mup.json contiene la configuración necesaria para el deploy y el settings.json son las settings con las que se ejecutará meteor en producción y las que posiblemente varíen entre un directorio de deploy y otro.

mup.json configuración básica

Deploy Meteor antiguos servidores (sin contenedores)

Para máquinas antiguas que no usan contenedores (i.e: Ada) el mup.json será algo parecido a esto:

{
  "servers": [
    {
      "host": "",
      "username": "root",
      "pem": "~/.ssh/id_rsa",
      "env":{
      }
    }
  ],
  "setupMongo": true,
  "setupNode": true,
  "nodeVersion": "4.8.3",
  "useMeteor4": true,
  "appName": "NombreApp",
  "app": "..",
  "env": {
    "PORT": "3000",
    "ROOT_URL": "https://example.binpar.com"
  },
  "deployCheckWaitTime": 120,
  "enableUploadProgressBar": true
}

Deploy Meteor nuevos servidores (con contenedores)

¡ATENCIÓN! MUY IMPORTANTE: Para el setup del primer docker de un contenedor que aún no existe debemos de tener en cuenta una cosa muy importante: no tenemos ni puerto ni password de ese contenedor porque no existe. Por lo que nuestro mup.json, en el caso de servidores con contenedores tendrá configuraciones adicionales. Las más importantes son estas:

{
  "servers": [
    {
      "host": "",
      "username": "root",
      //{{PASSWORD}}
      //{{SSH_OPTIONS}}
      "env":{
      }
    }
  ],
  ...
  "containersConfig": true,
  "containerName": "NombreContenedor",
  ...
}

Podemos observar algo extraño: //{{PASSWORD}} y //{{SSH_OPTIONS}}. Esto le permite a mupx sustituir esas líneas por la configuración del contenedor una vez creado después de ejecutar el mupx setup.

Todas las configuraciones que estén destinadas a un servidor con contenedores deben tener containersConfig a true y un containerName que al hacer mupx setup se creará si no existe.

Deploy NextJS and new node APIs

Por último, la configuración de servidores NextJS es exactamente igual a los dos casos anteriores solo que especificaremos una nodeVersion superior a 6.11.0 y añadiremos la configuración nextjs: true quedando de la siguiente forma:

{
  "servers": [
    {
      "host": "host",
      "username": "root",
      //{{PASSWORD}}
      //{{SSH_OPTIONS}}
      "env":{
      }
    }
  ],
  "setupMongo": true,
  "setupNode": true,
  "nodeVersion": "8.4.0",
  "nextjs": true,
  "appName": "NombreApp",
  "publishNetwork":"0.0.0.0",
  "containersConfig": true,
  "containerName": "ContainerName",
  "app": "..",
  "dirExclusions": ["design"],
  "env": {
    "PORT": "3000",
    "ROOT_URL": "https://example.binpar.com"
  },
  "deployCheckWaitTime": 120,
  "enableUploadProgressBar": true
}

Como podéis ver es parecido al deploy de Meteor en servidores con contenedores con la diferencia de que en vez de useMeteor4 tenemos nextjs: true.

También tenemos una configuración adicional en deploys de NextJS y nuevos proyectos node que es dirExclusions. Es un array de Strings que nos permite especificar directorios de primer nivel que serán excluidos. Siempre estarán excluidos por defecto los siguientes directorios además de todos los que empiezan por . (es decir, ocultos):

['node_modules', '__test__', 'coverage']

¡NOTA! Para el correcto funcionamiento de este deploy hay unos pre-requisitos:

  1. Los babel runtimes, presets y plugins necesarios para la transpilación del proyecto deben estar en dependencies y NO en devDependencies.
  2. Es obligatorio que exista un npm script llamado build que realice la transpilación del proyecto.
  3. Es obligatorio que el npm script start inicie el proyecto con la variable de entorno NODE_ENV=production y desde la ruta a la versión transpilada.

¡Importante! el parámetro nextjs prevalece sobre useMeteor4

OLD README

Production Quality Meteor Deployments

Meteor Up is a command line tool that allows you to deploy any Meteor app to your own server. It currently supports Ubuntu. There are plans to support other linux distros soon.

You can use install and use Meteor Up from Linux, Mac and Windows.

This version of Meteor Up is powered by Docker and it makes Meteor Up easy to manage. It also reduce a lot of server specific errors.

Table of Contents

Features

Server Configuration

Installation

npm install -g mupx

Creating a Meteor Up Project

mkdir ~/my-meteor-deployment
cd ~/my-meteor-deployment
mupx init

This will create two files in your Meteor Up project directory:

mup.json is commented and easy to follow (it supports JavaScript comments).

Example File

{
  // Server authentication info
  "servers": [
    {
      "host": "hostname",
      "username": "root",
      "password": "password",
      // or pem file (ssh based authentication)
      // WARNING: Keys protected by a passphrase are not supported
      //"pem": "~/.ssh/id_rsa"
      // Also, for non-standard ssh port use this
      //"sshOptions": { "port" : 49154 },
      // server specific environment variables
      "env": {}
    }
  ],

  // Install MongoDB on the server. Does not destroy the local MongoDB on future setups
  "setupMongo": true,

  // Application name (no spaces).
  "appName": "meteor",

  // Location of app (local directory). This can reference '~' as the users home directory.
  // i.e., "app": "~/Meteor/my-app",
  // This is the same as the line below.
  "app": "/Users/arunoda/Meteor/my-app",

  // Configure environment
  // ROOT_URL must be set to your correct domain (https or http)
  "env": {
    "PORT": 80,
    "ROOT_URL": "http://myapp.com"
  },

  // Meteor Up checks if the app comes online just after the deployment.
  // Before mup checks that, it will wait for the number of seconds configured below.
  "deployCheckWaitTime": 15,

  // show a progress bar while uploading.
  // Make it false when you deploy using a CI box.
  "enableUploadProgressBar": true
}

Setting Up a Server

mupx setup

This will setup the server for the mupx deployments. It will take around 2-5 minutes depending on the server's performance and network availability.

Deploying an App

mupx deploy

This will bundle the Meteor project and deploy it to the server. Bundling process is very similar to how meteor deploy do it.

Other Utility Commands

Build Options

When building the meteor app, we can invoke few options. So, you can mention them in mup.json like this:

...
"buildOptions": {
  // build with the debug mode on
  "debug": true,
  // mobile setting for cordova apps
  "mobileSettings": {
    "public": {
      "meteor-up": "rocks"
    }
  },
  // executable used to build the meteor project
  // you can set a local repo path if needed
  "executable": "meteor"
}
...

Additional Setup/Deploy Information

Deploy Wait Time

Meteor Up checks if the deployment is successful or not just after the deployment. By default, it will wait 15 seconds before the check. You can configure the wait time with the deployCheckWaitTime option in the mup.json

SSH keys with paraphrase (or ssh-agent support)

This only tested with Mac/Linux

It's common to use paraphrase enabled SSH keys to add an extra layer of protection to your SSH keys. You can use those keys with mup too. In order to do that, you need to use a ssh-agent.

Here's the process:

Ssh based authentication with sudo

If your username is root or using AWS EC2, you don't need to follow these steps

Please ensure your key file (pem) is not protected by a passphrase. Also the setup process will require NOPASSWD access to sudo. (Since Meteor needs port 80, sudo access is required.)

Make sure you also add your ssh key to the /YOUR_USERNAME/.ssh/authorized_keys list

You can add your user to the sudo group:

sudo adduser *username*  sudo

And you also need to add NOPASSWD to the sudoers file:

sudo visudo

# replace this line
%sudo  ALL=(ALL) ALL

# by this line
%sudo ALL=(ALL) NOPASSWD:ALL

When this process is not working you might encounter the following error:

'sudo: no tty present and no askpass program specified'

Server Setup Details

Meteor Up uses Docker to run and manage your app. It uses MeteorD behind the scenes. Here's how we manage and utilize the server.

For more information see lib/taskLists.js.

Multiple Deployment Targets

You can use an array to deploy to multiple servers at once.

To deploy to different environments (e.g. staging, production, etc.), use separate Meteor Up configurations in separate directories, with each directory containing separate mup.json and settings.json files, and the mup.json files' app field pointing back to your app's local directory.

Accessing the Database

You can't access the MongoDB from the outside the server. To access the MongoDB shell you need to log into your server via SSH first and then run the following command:

docker exec -it mongodb mongo <appName>

Later on we'll be using a separate MongoDB instance for every app.

Server Specific Environment Variables

It is possible to provide server specific environment variables. Add the env object along with the server details in the mup.json. Here's an example:

{
  "servers": [
    {
      "host": "hostname",
      "username": "root",
      "password": "password"
      "env": {
        "SOME_ENV": "the-value"
      }
    }

  ...
}

By default, Meteor Up adds CLUSTER_ENDPOINT_URL to make cluster deployment simple. But you can override it by defining it yourself.

Multiple Deployments

Meteor Up supports multiple deployments to a single server. Meteor Up only does the deployment; if you need to configure subdomains, you need to manually setup a reverse proxy yourself.

Let's assume, we need to deploy production and staging versions of the app to the same server. The production app runs on port 80 and the staging app runs on port 8000.

We need to have two separate Meteor Up projects. For that, create two directories and initialize Meteor Up and add the necessary configurations.

In the staging mup.json, add a field called appName with the value staging. You can add any name you prefer instead of staging. Since we are running our staging app on port 8000, add an environment variable called PORT with the value 8000.

Now setup both projects and deploy as you need.

Changing appName

It's pretty okay to change the appName. But before you do so, you need to stop the project with older appName

Custom configuration and settings files

You can keep multiple configuration and settings files in the same directory and pass them to mup using the command parameters --settings and --config. For example, to use a file mup-staging.json and staging-settings.json add the parameters like this:

mup deploy --config=mup-staging.json --settings=staging-settings.json

SSL Support

Meteor Up can enable SSL support for your app. It's uses the latest version of Nginx for that.

To do that just add following configuration to your mup.json file.

{
  ...

  "ssl": {
    "certificate": "./bundle.crt", // this is a bundle of certificates
    "key": "./private.key", // this is the private key of the certificate
    "port": 443 // 443 is the default value and it's the standard HTTPS port
  }

  ...
}

Now, simply do mup setup and then mup deploy. Now your app is running with a modern SSL setup.

To learn more about the SSL setup refer to the mup-frontend-server project.

Updating Mup

To update mupx to the latest version, just type:

npm update mupx -g

You should try and keep mupx up to date in order to keep up with the latest Meteor changes.

Troubleshooting

Check Logs

If you suddenly can't deploy your app anymore, first use the mupx logs -f command to check the logs for error messages.

One of the most common problems is your Node version getting out of date. In that case, see “Updating” section above.

Verbose Output

If you need to see the output of mupx (to see more precisely where it's failing or hanging, for example), run it like so:

DEBUG=* mupx <command>

where <command> is one of the mupx commands such as setup, deploy, etc.

Migrating from Meteor Up 0.x

mupx is not fully backward compatible with Meteor Up 0.x. But most of the mup.json remain the same. Here are some of the changes:

Migration Guide

Use a new server if possible as you can. Then migrate DNS accordingly. That's the easiest and safest way.

Let's assume our appName is meteor

Then do mupx setup and then mupx deploy.