Author Archives: Chef

Comandos básicos de Git

Este post incluye una lista de comandos básicos de Git, validos para cualquier implementación del famoso VCS. Se recomienda una revisión más exhaustiva de los mismos en caso de necesitarlo. Se puede encontrar más información en:

https://git-scm.com/

Algunos de los comandos más usados son los siguiente:

Git config

Configuración de la herramienta Git (i.e. identificación de usuario). Más info en https://git-scm.com/book/es/v1/Empezando-Configurando-Git-por-primera-vez

$ git config --global user.name "Pepe Perez"
$ git config --global user.email peperez@foo.com

1 2	$ git config --global user.name "Pepe Perez" $ git config --global user.email peperez@foo.com

Git SSH keys generation

Generación de clave pública para conexión a Git via SSH. Recomendable para no tener que introducir usuario y password con cada operación remota.

$ ssh-keygen -t rsa -C "peperez@foo.com"

1	$ ssh-keygen -t rsa -C "peperez@foo.com"

Clone the repo

Clona el repositorio remoto en el local y actualiza el workspace.

$ git clone &lt;http url/ssh url&gt;

1	$ git clone <http url/ssh url>

Update working copy

Descarga el contenido del repositorio remoto al local y actualiza el workspace (necesita la operación de clonación anterior para inicializar los repositorios locales).

$ git pull

1	$ git pull

Update local repository but not working copy

Actualiza repositorios locales con el contenido remoto pero no modifica la copia local.

$ git fetch

1	$ git fetch

Check working copy status

Revisa el estado del workspace en relación al contenido del repositorio local.

$ git status

1	$ git status

Check local branches

Lista las ramas del repositorio local.

$ git branch

1	$ git branch

Upload a modification

Añade una modificación al repositorio local y remoto.

1. Añade las modificaciones al stage

$ git add <file_names>

1	$ git add <file_names>

2. Comitea al repositorio local

$ git commit -m “Commit message”

1	$ git commit -m “Commit message”

3. Subo al repositorio remoto

$ git push origin <branch>

1	$ git push origin <branch>

Show commit history

Muestra el histórico de commits locales.

$ git log [-n <num_logs>]

1	$ git log [-n <num_logs>]

Show latest commit history

Muestra los datos del último commit local.

$ git show

1	$ git show

Show differences

Muestra diferencias entre:

Commits locales

$ git diff HEAD~2..HEAD

1	$ git diff HEAD~2..HEAD

Commits y ficheros

$ git diff HEAD myfile.txt

1	$ git diff HEAD myfile.txt

Ramas locales

$ git diff <branch|tag>

1	$ git diff <branch\|tag>

Stagged changes (compara stagged files con committed files)

$ git diff --staged

1	$ git diff --staged

Undo working copy changes (checkout local repo HEAD)

Descarga ultima modificación de la rama actual para el fichero indicado, sobreescribiendo los cambios locales.

$ git checkout -- <file>

1	$ git checkout -- <file>

Reset a stage (reverse git add operation)

Resetea los cambios locales aplicados al fichero en cuestion, volviendo al estado comiteado en el repositorio local.

$ git reset <file>

1	$ git reset <file>

Revert a commit (revert git add and git commit operations)

Revierte un commit local, creando otro nuevo con los estados anteriores.

$ git revert <commit_id> (get commit id using git show or git log)
$ git revert HEAD

1 2	$ git revert <commit_id> (get commit id using git show or git log) $ git revert HEAD

Stash changes

Almacena cambios en un stash para posterior uso.

Crea un stash

$ git stash

1	$ git stash

Lista stashes actuales

$ git stash list

1	$ git stash list

Muestra el contenido de un stash

$ git stash show [stash]

1	$ git stash show [stash]

Aplica el stash en la rama actual

$ git stash apply [stash]

1	$ git stash apply [stash]

Stash can be referred using indexes as: stash@{0,1,2,etc}: Use list to view them

Borra todos los stash locales

$ git stash clear

1	$ git stash clear

Y otros muchos comandos relacionados con los stashes que se pueden consultar aqui:

https://git-scm.com/docs/git-stash

Create a new branch (create if not exists)

Crea una nueva rama si no existe y cambia a ella.

$ git checkout -b develop

1	$ git checkout -b develop

Create a new branch, but do not change

Crea una nueva rama en el repo local pero no cambia a ella.

$ git branch develop

1	$ git branch develop

Checkout to a branch

Cambia a una rama ya existente.

$ git checkout develop

1	$ git checkout develop

Merge a branch

Mergea ramas y/o tags.

Mergea a la rama actual y aplica fast-forward, es decir, no creará ningún nuevo commit, simplemente apuntara la rama actual al commit mergeado, si es posible.

$ git merge <branch>

1	$ git merge <branch>

Mergea pero sin fast-forward, es decir, crear un nuevo commit para el merge (recomendable).

$ git merge <branch> --no-ff

1	$ git merge <branch> --no-ff

Delete a branch

Borra una rama del repositorio local.

$ git checkout -d &lt;branch&gt;

1	$ git checkout -d <branch>

Create a tag

Creación de tags.

Lista los tags existentes.

$ git tag

$ git tag

Crea el trag 1.0 con el contenido del HEAD, el commit o la rama indicados.

$ git tag 1.0 <HEAD|commit_id|<branch>>

1	$ git tag 1.0 <HEAD\|commit_id\|<branch>>

Crea un tag anotado (por defecto son light-weight).

$ git tag –a 1.0 <HEAD|commit_id|<branch>> -m <message>

1	$ git tag –a 1.0 <HEAD\|commit_id\|<branch>> -m <message>

Sube el tag al repositorio remoto.

$ git push origin <tag>

1	$ git push origin <tag>

Rebase

Es un mecanismo para realizar un merge, alternativo al anterior aunque más potente pero a su vez más sutil y peligroso.

El peligro viene a la hora de hacer rebase de ramas en el repositorio remoto. Esto puede generar confusión a la hora de crear nuevos commits asi como revertir cambios, etc. Por lo tanto, la recomendación es solo usar rebase en commits que se encuentren uicamente en el repositorio local.

Se basa en los siguiente: al hacer un rebase de una rama sobre otra, lo que se hace es aplicar los commits de la rama que se rebasa en la rama actual, en orden de aparición, respetando los commits de la rama original.

Por ejemplo, si disponemos de dos ramas, master y develop, con cambios diferentes, y ejecutamos lo siguiente:

$ git checkout develop
$ git rebase master

1 2	$ git checkout develop $ git rebase master

Aplicamos los commits de la rama master directamente a la rama develop, en el orden en el que aparecen en la master.

También se puede hacer el rebase sin hacer el checkout de la rama que va a rebasar, haciendo:

$ git rebase &lt;base_branch&gt; &lt;topic_branch&gt;
$ git rebase master develop

$ git rebase <base_branch> <topic_branch>

$ git rebase master develop

Si las ramas no tienen el mismo origen, por ejemplo si se quiere rebasar una rama de feature con la rama de develop y ésta no surgió de la de develop si no de otra rama de feature, podemos hacer:

$ git rebase --onto develop feature01 feature02

1	$ git rebase --onto develop feature01 feature02

Se haría el rebase de feature02 sobre develop con los commits de feature02 pero sin los de feature01.

Rebase vs Merge

La idea del merge es que aparezcan reflejados en la historia del repositorio todos los cambios realizados en y entre las ramas, mientras que con el rebase se podria modificar esa historia para que aparezcan ciertos commits en ramas que no se hicieron. La filosofia es diferente, con merge se ve lo que paso explicitamente mientras que rebase permite modificar esa historia para que refleje los cambios que se deseen. Un uso recomendado seria aplicar rebase en el repositorio local para aquello cambios aun no compartidos con el objetivo de limpiar la historia local, antes de compartirlos.

Cherry-pick

Aplica cambios de commits concretos a la rama actual:

$ git cherry-pick &lt;commit_id&gt;

1	$ git cherry-pick <commit_id>

Se pueden escoger multiples commits. Cada commit creara un nuevo commit en la rama actual.

Search for text

Buscador de texto desde Git.

$ git grep "<text>"

1	$ git grep "<text>"

Herramienta gráfica sencilla

$ gitk &

$ gitk &

Ejemplo de proyecto en Python con OO y recomendaciones

El siguiente post contiene un ejemplo de desarrollo de un pequeño proyecto con Python. Este proyecto hace uso de algunos de los elementos de la orientación a objetos en Python, asi como de algunas recomendaciones en el desarrollo con Python.

Que cocinamos

Un pequeño proyecto con Python que incluye lo siguiente:

Clases
Módulos
Paquetes
Ficheros de log
Tests
Documentación autogenerada

El proyecto se puede descargar integro desde https://github.com/luisalbertogh/oopython.git.

Ingredientes

Los requisitos para este proyecto son los siguientes:

Python 3.x
Sphinx [http://www.sphinx-doc.org/en/stable/install.html]
Your favourite editor

Paso a paso

Creamos una estrcutura para el proyecto con el siguiente diseño:

<proyecto>

|__ <config> [ficheros de configuración]

|__ <doc> [documentación]

|__ <proyecto> [código fuente]

|__ <test> [tests de unidad e integración]

Vease el conteido del proyecto a modo de ejemplo.

Código fuente

El código se estructura de la siguiente manera (de más básico a más complejo):

1. Creamos un módulo base que contiene una serie de clases que incluyen nuestro modelo y nuestra lógica de negocio [oopython\mypackage\module01.py]. Aquí encontramos:

Superclases

#Sportman superclass with init method.
class Sportbeing(metaclass=abc.ABCMeta):
  """
  Init method.
  """
  def __init__(self, gender, nationality):
    self.gender = gender;
    self.nationality = nationality;

#Sportman superclass with init method.

class Sportbeing(metaclass=abc.ABCMeta):

"""

Init method.

"""

def __init__(self, gender, nationality):

self.gender = gender;

self.nationality = nationality;

Clases con diferente tipos de métodos (estáticos, constructores (__init__), sobrecargados (métodos especiales que empiezan con __. etc))

#Subclass extends from superclass.
class Cyclist(Sportbeing):
  """
  Init method.
  """
  def __init__(self, gender, nationality, name):
    # Invoke superclass init
    super().__init__(gender, nationality);
    self.name = name;

  """
  Static mehod to create instances.
  """
  @staticmethod
  def createInstance():
    return Cyclist('male','Spanish','Valverde');

  """
  Set name.
  """
  def setName(self, team):
    self.name = name;

  """
  Print instance details (used in print).
  """
  def __str__(self):
    return self.gender + '; ' + self.nationality + '; ' + self.name;

#Subclass extends from superclass.

class Cyclist(Sportbeing):

"""

Init method.

"""

def __init__(self, gender, nationality, name):

# Invoke superclass init

super().__init__(gender, nationality);

self.name = name;

"""

Static mehod to create instances.

"""

@staticmethod

def createInstance():

return Cyclist('male','Spanish','Valverde');

"""

Set name.

"""

def setName(self, team):

self.name = name;

"""

Print instance details (used in print).

"""

def __str__(self):

return self.gender + '; ' + self.nationality + '; ' + self.name;

Lazy properties, setters y getters

"""
Lazy property, created when invoked.
"""
@property
def director(self):
return self._director;

"""
Setter and deleter for riders.
"""
@director.setter
def director(self, director):
self._director = director;

@director.deleter
def director(self):
self._director = None;

"""

Lazy property, created when invoked.

"""

@property

def director(self):

return self._director;

"""

Setter and deleter for riders.

"""

@director.setter

def director(self, director):

self._director = director;

@director.deleter

def director(self):

self._director = None;

Clases estratégicas (sin estado, sólo lógica)

# Strategy class (stateless, no data, only logic).
class StageRules:
  def win(self, rider1, rider2):
    return True;

  def lose(self, rider1, rider2):
    return False;

# Strategy class (stateless, no data, only logic).

class StageRules:

def win(self, rider1, rider2):

return True;

def lose(self, rider1, rider2):

return False;

2. Incluimos este módulo en un paquete. Esto no es necesario en Python pero puede ser una buena recomendación para modular un poco más y aportar un nivel adicional de granularidad al código desarrollado. Los paquetes estarían compuestos por módulos y estos se podrían usar desde otros módulos y/o paquetes.

Para esto, simplemente creamos el directorio oopython\mypackage, incluimos el módulo recien creado dentro y añadimos un fichero __init__.py. Adicionalmente podemos incluir en el fichero __init__.py otros módulos o paquetes externos o indicar que módulos internos queremos habilitar desde el paquete, de tal manera que sea más sencillo invocarlos cuando se usen desde otros módulos externos. Si añadimos lo siguiente:

""" mypackage """
from mypackage.module01 import *;

1 2	""" mypackage """ from mypackage.module01 import *;

Podremos usar el contenido del paquete mypackage desde otros módulos externos simplemente haciendo:

from mypackage import *

1	from mypackage import *

De otra manera tendriamos que especificar el módulo, etc.

3. Creamos un nuevo módulo [oopython\oopython.py] que haga uso del paquete anteriormente creado.

# Import classes from module
from mypackage import *;
...
mov = Team('Movistar', Cyclist('male','Spanish','Valverde'), Cyclist('male','Colombian','Quintana'), Cyclist('male','Basque','Izagirre'));
logger.info(mov);
logger.info('Num. de corredores: {0}'.format(mov.totalriders));
...

# Import classes from module

from mypackage import *;

...

mov = Team('Movistar', Cyclist('male','Spanish','Valverde'), Cyclist('male','Colombian','Quintana'), Cyclist('male','Basque','Izagirre'));

logger.info(mov);

logger.info('Num. de corredores: {0}'.format(mov.totalriders));

...

Ficheros de log

Para disponer de una serie de loggers que permitan crear ficheros de log e imprimir mensajes por pantalla, usamos paquetes estandar de logging de Python y YAML como lenguaje para los ficheros de configuración de los mismos.

En caso de que YAML no esté instalado, usar:

$ pip install pyyaml

1	$ pip install pyyaml

En el módulo principal incluimos el siguiente código:

# YAML & logging
import yaml;
import logging;
import logging.config;
...
# Init logger
logdict = yaml.load(open('config/log_config.yaml', 'r'));
logging.config.dictConfig(logdict);
logger = logging.getLogger('MyLogger');
...

# YAML & logging

import yaml;

import logging;

import logging.config;

...

# Init logger

logdict = yaml.load(open('config/log_config.yaml', 'r'));

logging.config.dictConfig(logdict);

logger = logging.getLogger('MyLogger');

...

El fichero de configuracion de los logs se encuentra en la ruta config/log_config.yaml. Contiene los valores necesarios para crear differentes tipos de loggers, configurar salidas por consola, formato de los logs, etc.

...
handlers:
 console:
  class: logging.StreamHandler
  stream: ext://sys.stderr
  formatter: basic
 mylogger:
  class: logging.handlers.TimedRotatingFileHandler
  filename: mylog.log
  encoding: utf-8
  formatter: basic
  when: D # S - seconds, M - minutes, H - hours, D - Days, W0-W6 - weekday, midnight
  interval: 1
  backupCount: 5
...

...

handlers:

console:

class: logging.StreamHandler

stream: ext://sys.stderr

formatter: basic

mylogger:

class: logging.handlers.TimedRotatingFileHandler

filename: mylog.log

encoding: utf-8

formatter: basic

when: D # S - seconds, M - minutes, H - hours, D - Days, W0-W6 - weekday, midnight

interval: 1

backupCount: 5

...

Tests

Tal y como ocurre en otros lenguajes de programación, aqui también podemos crear tests de unidad y de integración que se ejecuten de forma automática dentro de un proceso de integración continua.

En un directorio separado dentro del proyecto llamado test, creamos diferentes ficheros (módulos) con diferentes grupos de tests. Cada módulo podría ser considerado como un test suite diferente, por ejemplo.

Dentro de cada módulo incluimos diferentes tests unitarios usando el módulo de Python para implementar tests de unidad:

import unittest;

1	import unittest;

Para que los tests puedan hacer uso de los módulos y paquetes internos del proyecto, se setea la ruta principal del proyecto relativa al test:

"""
Apend module path so tests can used project modules.
"""
import sys;
import os;
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__),"..")) + "\oopython");
from mypackage import *;

"""

Apend module path so tests can used project modules.

"""

import sys;

import os;

sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__),"..")) + "\oopython");

from mypackage import *;

Los tests unitarios son métodos del siguiente TestCase:

 # Test case class
class TestOopython(unittest.TestCase):
  """
  Test case.
  """
  #Set up test case
  def setUp(self):
    self.testteam = Team('Test', Cyclist('male','Spanish','Valverde'), Cyclist('male','Colombian','Quintana'), Cyclist('male','Basque','Izagirre'));

  # Test number of raiders
  def test_team_members(self):
    self.assertEqual(3, self.testteam.totalriders);

  # Test included raiders
  def test_raiders(self):
    self.assertEqual(Cyclist('male','Spanish','Valverde'), self.testteam[0]);
    self.assertEqual(Cyclist('male','Colombian','Quintana'), self.testteam[1]);
    self.assertEqual(Cyclist('male','Basque','Izagirre'), self.testteam[2]);

# Test case class

class TestOopython(unittest.TestCase):

"""

Test case.

"""

#Set up test case

def setUp(self):

self.testteam = Team('Test', Cyclist('male','Spanish','Valverde'), Cyclist('male','Colombian','Quintana'), Cyclist('male','Basque','Izagirre'));

# Test number of raiders

def test_team_members(self):

self.assertEqual(3, self.testteam.totalriders);

# Test included raiders

def test_raiders(self):

self.assertEqual(Cyclist('male','Spanish','Valverde'), self.testteam[0]);

self.assertEqual(Cyclist('male','Colombian','Quintana'), self.testteam[1]);

self.assertEqual(Cyclist('male','Basque','Izagirre'), self.testteam[2]);

Los test unitarios se cargan en un único test suite:

# Test suite with pervious test cases
def testsuite():
  s = unittest.TestSuite();
  load_from = unittest.defaultTestLoader.loadTestsFromTestCase;
  s.addTests(load_from(TestOopython));
  return s;

# Test suite with pervious test cases

def testsuite():

s = unittest.TestSuite();

load_from = unittest.defaultTestLoader.loadTestsFromTestCase;

s.addTests(load_from(TestOopython));

return s;

Y se ejcutan:

# Run test suite
if __name__ == "__main__":
  """
  Run test suite
  """
  tr = unittest.TextTestRunner();
  tr.run(testsuite());

# Run test suite

if __name__ == "__main__":

"""

Run test suite

"""

tr = unittest.TextTestRunner();

tr.run(testsuite());

Una manera sencilla de lanzar todos (o los seleccionados) tests es usando el siguiente comando:

$ python -m unittest discover test

1	$ python -m unittest discover test

Se indica el uso del módulo de testeo de Python y se le indica que ejecute todos los tests unitarios que encuentre en el directorio test correspondiente. También se pueden lanzar como un scrupt de Python sin más.

Generación automática de documentación

La generación automática está basada en el uso de la herramienta Sphinx, que es una de las más extendidas. Los pasos para ejecutarla son basicamente los siguientes:

Instalar Sphinx

http://www.sphinx-doc.org/en/stable/install.html

Ejecutar Sphinx quickstart

Se recomienda seguir este tutorial para concer las opciones más relevantes de este comando. Es importante activar la generación automática de documentación si queremos que la herramienta convierta los comentarios incluidos en el código en Python como texto dentro de la documentación.

http://www.sphinx-doc.org/en/stable/tutorial.html

$ sphinx-quickstart

1	$ sphinx-quickstart

Revisar valores en conf.py

Antes de lanzar la generación automática de documentación conviene revisar el fichero de configuración autogenerado por el paso anterior. Éste se encuentra en oopython\doc\source\conf.py.

Una de las modificaciones que tenemos que aplicar al fichero recien creado es indicar la ruta en la que se encuentra el código de Python para que los pasos siguientes puedan autogenerar documentación:

sys.path.insert(0, os.path.abspath('../../oopython'))

1	sys.path.insert(0, os.path.abspath('../../oopython'))

De esta manera se añade a la ruta en la que Python busca los módulos y paquetes la ruta que contiene nuestro código.

Sphinx apidoc

Nos permite de forma automática generar los ficheros RST que se usaran para dar formato a la páginas de la documentación que se incluirá asi como su contenido. Normalmente se creara un fichero RST por módulo/paquete y se añadirá información sobre las clases y miembros.

Submodules
----------

mypackage.module01 module
-------------------------

.. automodule:: mypackage.module01
  :members:
  :undoc-members:
  :show-inheritance:

Module contents
---------------

.. automodule:: mypackage
  :members:
  :undoc-members:
  :show-inheritance:

Submodules

----------

mypackage.module01 module

-------------------------

.. automodule:: mypackage.module01

:members:

:undoc-members:

:show-inheritance:

Module contents

---------------

.. automodule:: mypackage

:members:

:undoc-members:

:show-inheritance:

Más información aqui: http://scriptsonscripts.blogspot.com.es/2012/09/quick-sphinx-documentation-for-python.html

El comando de ejecución sería el siguiente. doc/source sería el directorio en el que se generarán los RST y oopython el directorio que contiene el código fuente en Python.

$ sphinx-apidoc -F -o doc/source oopython

1	$ sphinx-apidoc -F -o doc/source oopython

Crear la documentación

Se lanza el siguiente comando:

$ sphinx-build -b html doc/source/ doc/build/

1	$ sphinx-build -b html doc/source/ doc/build/

Y se genera el formato de salida deseado, en este caso en HTML:

$ cd doc
$ make html

1 2	$ cd doc $ make html

Docker tips

En este post se incluyen una revisión muy sencilla y un conjunto de comandos y acciones relacionadas con el uso de Docker. Para más información, consultar en:

https://docs.docker.com/engine/docker-overview/

https://training.docker.com/

https://veggiemonk.github.io/awesome-docker/

Containers

Running a container

docker container run hello-world

1	docker container run hello-world

Pull an image from the Docker registry

docker image pull alpine

1	docker image pull alpine

List the content of the downloaded Docker images

docker image ls

1	docker image ls

Run commands on a launched container

docker container run alpine ls -l
</code><code>docker container run alpine echo "hello from alpine"

1 2	docker container run alpine ls -l </code><code>docker container run alpine echo "hello from alpine"

Launch container in interactive mode

docker container run -it alpine /bin/sh

1	docker container run -it alpine /bin/sh

List running containers (and ran)

docker container ls
docker container ls -a

1 2	docker container ls docker container ls -a

Images

Inspect an image

docker image inspect alpine

1	docker image inspect alpine

Download and run image in one goal

docker container run -d seqvence/static-site

1	docker container run -d seqvence/static-site

Stop and remove container

docker container stop &lt;container-id&gt;
docker container rm   &lt;container-id&gt;
docker container rm -f  &lt;container-id&gt;

docker container stop <container-id>

docker container rm <container-id>

docker container rm -f <container-id>

Run container in detached mode and provide details

docker container run --name static-site -e AUTHOR="Your Name" -d -P seqvence/static-site 
docker container run --name static-site -e AUTHOR="Your Name" -d –p 8888:80 seqvence/static-site

1 2	docker container run --name static-site -e AUTHOR="Your Name" -d -P seqvence/static-site docker container run --name static-site -e AUTHOR="Your Name" -d –p 8888:80 seqvence/static-site

--name --> Name to the container

-e --> Pass variables

-d --> detached mode

-P --> publish ports to docker container host

-p 8888:80 --> Relate port 80 to 8888 in docker host

Image types

Base

OS images

Child

Based on a base image

Official

Certified by Docker

User

User created images (from base, usually)

Create a new image (user image)

Create a docker file (Dockerfile)

# our base image
FROM alpine:edge
# Install python and pip
RUN apk add --update py2-pip
# install Python modules needed by the Python app
COPY requirements.txt /usr/src/app/
RUN pip install --no-cache-dir -r /usr/src/app/requirements.txt 
# copy files required for the app to run
COPY app.py /usr/src/app/
COPY templates/index.html /usr/src/app/templates/
# tell the port number the container should expose
EXPOSE 5000
# run the application
CMD ["python", "/usr/src/app/app.py"]

# our base image

FROM alpine:edge

# Install python and pip

RUN apk add --update py2-pip

# install Python modules needed by the Python app

COPY requirements.txt /usr/src/app/

RUN pip install --no-cache-dir -r /usr/src/app/requirements.txt

# copy files required for the app to run

COPY app.py /usr/src/app/

COPY templates/index.html /usr/src/app/templates/

# tell the port number the container should expose

EXPOSE 5000

# run the application

CMD ["python", "/usr/src/app/app.py"]

Build the image

docker image build -t <YOUR_USERNAME>/myfirstapp .

1	docker image build -t <YOUR_USERNAME>/myfirstapp .

-t –> image tag

. –> directory where Dockerfile is present

Swarm stack

Init swarm manager

docker swarm init --advertise-addr $(hostname -i)

1	docker swarm init --advertise-addr $(hostname -i)

Docker compose files (docker-compose.yml)

version:<code> </code>"3"
</code>services:<code></code><code>
</code>    web:<code></code><code>
      </code># replace username/repo:tag with your name and image details<code></code><code>
      </code>image:<code> </code>username/repository:tag<code></code><code>
      </code>deploy:<code>
        replicas:<code> </code>5
</code>resources:
          </code>limits:<code></code><code>
            </code>cpus:<code> </code>"0.1"<code></code><code>
            </code>memory:<code> </code>50M<code>
        restart_policy:<code></code><code>
          </code>condition:<code> </code>on-failure<code></code><code>
       </code>ports:<code></code><code>
         </code>-<code> </code>"80:80"<code></code><code>
       </code>networks:<code></code><code>
         </code>-<code> </code>webnet
</code>networks:<code></code><code>
       </code>webnet:<code>

version:<code> </code>"3"

</code>services:<code></code><code>

</code> web:<code></code><code>

</code># replace username/repo:tag with your name and image details<code></code><code>

</code>image:<code> </code>username/repository:tag<code></code><code>

</code>deploy:<code>

replicas:<code> </code>5

</code>resources:

</code>limits:<code></code><code>

</code>cpus:<code> </code>"0.1"<code></code><code>

</code>memory:<code> </code>50M<code>

restart_policy:<code></code><code>

</code>condition:<code> </code>on-failure<code></code><code>

</code>ports:<code></code><code>

</code>-<code> </code>"80:80"<code></code><code>

</code>networks:<code></code><code>

</code>-<code> </code>webnet

</code>networks:<code></code><code>

</code>webnet:<code>

Deploy the stack

docker stack deploy -c docker-compose.yml &lt;stack_name&gt;
docker-compose up -d

docker stack deploy -c docker-compose.yml <stack_name>

docker-compose up -d

Join swarm

docker swarm join &lt;ip&gt;:&lt;port&gt;

1 2	docker swarm join <ip>:<port>

List nodes

docker node ls

1 2	docker node ls

List services

docker stack services &lt;stack_name&gt;
docker-compose ps

1 2	docker stack services <stack_name> docker-compose ps

Inspect services

docker service inspect &lt;service_name&gt;

1	docker service inspect <service_name>

Scale up or down the service

docker service scale &lt;service_name&gt;=&lt;service_number&gt;
docker-compose scale &lt;service_name&gt;=&lt;service_number&gt;
docker service update --replicas &lt;service_number&gt; &lt;service_name&gt;

docker service scale <service_name>=<service_number>

docker-compose scale <service_name>=<service_number>

docker service update --replicas <service_number> <service_name>

Disable/Enable nodes

docker node update --availability drain &lt;node_name&gt;
docker node update --availability active &lt;node_name&gt;
docker node inspect &lt;node_name&gt; --pretty

docker node update --availability drain <node_name>

docker node update --availability active <node_name>

docker node inspect <node_name> --pretty

List deployed tasks

docker stack ps &lt;stack_name&gt;

1	docker stack ps <stack_name>

Leave the swarm

docker swarm leave

1	docker swarm leave

Remove stack

docker swarm rm &lt;stack_name&gt;</code> 
docker-compose down

1 2	docker swarm rm <stack_name></code> docker-compose down

Inspect the container

docker container inspect &lt;container_name&gt; 
docker container inspect --format "{{ .Config.Hostname }}" &lt;container_name&gt;

1 2	docker container inspect <container_name> docker container inspect --format "{{ .Config.Hostname }}" <container_name>

Persist de data

In the host, via de docker-compose file:

redis:<code>
  image:<code> </code>redis<code>
  ports:<code>
    -<code> </code>"6379:6379"<code></code><code>
  </code>volumes:<code>
    -<code> </code>./data:/data

redis:<code>

image:<code> </code>redis<code>

ports:<code>

-<code> </code>"6379:6379"<code></code><code>

</code>volumes:<code>

-<code> </code>./data:/data

Via de Docker file:

VOLUME ["/data"]

1	VOLUME ["/data"]

The /data will be created on the host as well:

docker container inspect -f "{{ json .Mounts }}"  c2 | python -m json.tool

1	docker container inspect -f "{{ json .Mounts }}" c2 \| python -m json.tool

[
  {
    "Destination": "/data",
    "Driver": "local",
    "Mode": "",
    "Name": "2f5b7c6b77494934293fc7a09198dd3c20406f05272121728632a4aab545401c",
    "Propagation": "",
    "RW": true,
    "Source": "/graph/volumes/2f5b7c6b77494934293fc7a09198dd3c20406f05272121728632a4aab545401c/_data",
    "Type": "volume"
  }
]

[

{

"Destination": "/data",

"Driver": "local",

"Mode": "",

"Name": "2f5b7c6b77494934293fc7a09198dd3c20406f05272121728632a4aab545401c",

"Propagation": "",

"RW": true,

"Source": "/graph/volumes/2f5b7c6b77494934293fc7a09198dd3c20406f05272121728632a4aab545401c/_data",

"Type": "volume"

}

]

Using the –v option

Create and mount
Mount

docker container run --name c3 -d -v /data alpine sh -c 'ping 8.8.8.8 &gt; /data/ping.txt'
</code><code>docker container run -v HOST_PATH:CONTAINER_PATH [OPTIONS] IMAGE [CMD]

1 2	docker container run --name c3 -d -v /data alpine sh -c 'ping 8.8.8.8 > /data/ping.txt' </code><code>docker container run -v HOST_PATH:CONTAINER_PATH [OPTIONS] IMAGE [CMD]

Using the Volume API

Create the volumen on the host

docker volume create --name &lt;vol_name&gt;
docker volume inspect html
[
  {
    "Driver": "local",
    "Labels": {},
    "Mountpoint": "/graph/volumes/html/_data",
    "Name": "html",
    "Options": {},
    "Scope": "local"
  }
]

docker volume create --name <vol_name>

docker volume inspect html

[

{

"Driver": "local",

"Labels": {},

"Mountpoint": "/graph/volumes/html/_data",

"Name": "html",

"Options": {},

"Scope": "local"

}

]

Mount it and use it within a container

docker container run --name www -d -p 8080:80 -v html:/usr/share/nginx/html nginx

1	docker container run --name www -d -p 8080:80 -v html:/usr/share/nginx/html nginx

Docker network drivers (default and created)

Bridge support only a single node
Overlay support multiple nodes

docker network ls

1	docker network ls

Create overlay network

docker network create -d overlay &lt;network_name&gt;

1	docker network create -d overlay <network_name>

Inspect network

docker network inspect &lt;network_name&gt;

1	docker network inspect <network_name>

Run container within network

docker run -d --net=&lt;network_name&gt; --name &lt;container_name&gt; &lt;image_name&gt;

1 2	docker run -d --net=<network_name> --name <container_name> <image_name>

By default, bridge network driver is used

docker run -d --name <container_name> <image_name> <command>

1	docker run -d --name <container_name> <image_name> <command>

Connect an existent container to an existent network

docker network connect &lt;network_name&gt; &lt;container_name&gt;

1	docker network connect <network_name> <container_name>

Service discovery

docker ps

docker ps

Docker info

docker info

1	docker info

Use Docker API to communicate with Docker

docker-machine env <node_name> --> apply docker commands on that node (alternative, use DOCKER_HOST variable)

1	docker-machine env <node_name> --> apply docker commands on that node (alternative, use DOCKER_HOST variable)

Upgrade/downgrade to/from manager

docker node promote <node_name_or_id>
docker node demote <node_name_or_id>

1 2	docker node promote <node_name_or_id> docker node demote <node_name_or_id>

Docker swarm visualizer

http://jpetazzo.github.io/orchestration-workshop/#118