Deploiement .Net Core 2.1 sur Heroku en utilisant une image Docker
Pré-requis
- Docker en local
- Client heroku (CLI) installé et configuré
- Git, pour cloner un repository
- Dotnet core 2.1.x installé (ou plus récent)
Exécuter en local
Docker: Images à pré-télécharger
Le build va reposer principalement sur 2 images. Ces images peuvent aussi être téléchargée automatiquement lors du lancement de la commande docker build lors d’une étape subséquente. Si vous voulez lancer les téléchargements en avance, lancez les commandes “docker pull” suivantes:
> docker pull microsoft/dotnet:2.1.500-sdk-alpine3.7 > docker pull microsoft/dotnet:2.1.6-aspnetcore-runtime-alpine3.7
Créer un projet, ou faire du scaffolding
Je vais opter pour du scaffolding sur un de mes templates. Pour lancer l’installation du template en local faite à partir d’un dossier vide dotnet new -i HoNoSoFt.DotNet.Web.Spa.ProjectTemplates
. Ensuite, faire dotnet new vuejs-picnic
afin de lancer le scaffolding.
Cette étape n’est sans doutes pas obligatoire, mais sachez qu’Heroku vous procure le HTTPS sans doute en utilisant un reverse proxy (je ne fait que supposer ici). Du coup, vous pouvez désactiver le HTTPS du le projet surtout si vous n’avez pas de certificat valide. Le fichier a modifier est le Startup.cs, mettez en commentaire les lignes app.UseHttpsRedirection();
et app.UseHsts();
.
À priori, vous avez votre projet disponible. Vous pourrez donc effectuer un dotnet build
histoire de vous assurer que le build fonctionne. Et ensuite dotnet run
vous permettra de voir avec Kestrel votre site sur https://localhost:5001/.
Faire un build local de votre image Docker
Comme vous l’avez sans doute constaté, ou pas, le projet template utilisé pour le scaffolding contenait déjà un fichier Dockerfile. Ce fichier décrit comment effectuer un build et ensuite vous donne l’option d’exécuter l’image en local.
Contenu du fichier:
#################################################### # To build your own image: # > docker build -t honosoft/vuejs-picnic:latest -t honosoft/vuejs-picnic:1.0 . # To run your image once it's ready: # > docker run -d -p 39803:80 --name vuejs-picnic honosoft/vuejs-picnic # To push the image into your docker repository: # > docker push honosoft/vuejs-picnic:latest # If you wish to remove your dangling images, please do the following (not mandatory) # > docker rmi $(docker images -f “dangling=true” -q) #################################################### # Build the container with Source code compiled FROM microsoft/dotnet:2.1.500-sdk-alpine3.7 as buildenv WORKDIR /source RUN apk add --update nodejs nodejs-npm COPY *.csproj . RUN dotnet restore COPY . . # Publishing will also restore (install) the npm packages. RUN dotnet publish -c Release -o /app/ # Stage 2 - Creating Image for compiled app FROM microsoft/dotnet:2.1.6-aspnetcore-runtime-alpine3.7 as baseimage RUN addgroup -S coreApp && adduser -S -G coreApp coreApp RUN apk add --update nodejs nodejs-npm WORKDIR /app COPY --from=buildenv /app . RUN chown -R coreApp:coreApp /app # Replace the application name if required. CMD ASPNETCORE_URLS=http://+:$PORT dotnet Sample.Heroku.dll
IMPORTANT! Si vous utilisez “ENTRYPOINT” pour lancer l’application, ça marchera en local mais pas sur Heroku. Ce qui fait en sorte que vous devrez remplacer la commande par “CMD”, pour plus de détails cliquer ici
Comme avez pu le constater, mon projet s’appelle Sample.Heroku et le point d’entrée afin de démarrer le conteneur sera le fichier Sample.Heroku.dll. Les images utilisée sont la SDK afin de faire la compilation et ensuite l’image Runtime afin d’exécuter la publication en mode Production.
Pour bâtir votre docker, exécuter la commande docker build -t honosoft/sample-heroku:latest .
. L’image devrait faire dans les 200mb décompressé et environs 80mo compressée. Il y a des moyens afin de diminuer cela, mais pour le moment on se contentera des images par défaut fournie par Microsoft.
Une fois le build terminé, vous pourrez lister vos images avec la commande docker images. Si votre image s’est construite sans soucis, vous pourrez passer à l’étape suivante, sinon vous devrez faire des corrections par rapport aux erreurs.
Lancer l’image docker en local pour tester
Rien de plus simple, par défaut, docker avec dotnet core utilise le port 80 en interne. Du coup, pour lancer votre image, effectuer la commande suivante:
docker run -d -p 8080:80 --name sample-heroku honosoft/sample-heroku
Votre image devrait donc désormais être disponible en atteignant http://localhost:8080 par le proxy créé par Docker (Port 80 sur Docker et exposé sur votre machine sur 8080).
Déploiement sur Heroku
Créer une application sur Heroku
À partir du dashboard, simplement créer une nouvelle application. Dans mon cas, l’application sera “morning-oasis-26273”.
Deploiement avec le CLI
Vous connecter à votre compte Heroku avec le CLI:
heroku login heroku container:login
Comme vous le feriez pour envoyer vers les registres de Docker privé, effectuer un tag Heroku de votre image fraîchement créée. Ensuite, vous n’aurez qu’à faire un push (à la git), de votre image vers votre site web.
docker tag honosoft/sample-heroku registry.heroku.com/morning-oasis-26273/web docker push registry.heroku.com/morning-oasis-26273/web
Alternativement au docker tag/push vous pouvez aussi utiliser la commande Heroku qui effectuera les 2 commandes en une seule:
heroku container:push web -a morning-oasis-26273
Lors du push, ça prendra un peu de temps tout dépendant de votre connexion internet. Le push, tel que pour GIT enverra la différence vers le serveur de registre Docker. Le premier push prendra un peu plus de temps, mais les push subséquents seront rapide et avec un faible volume de données à envoyer.
Tout ce qui reste à faire maintenant, est d’activer votre image sur le site Heroku à l’aide du CLI:
heroku container:release web -a morning-oasis-26273
Avant d’atteindre votre application, vous pouvez tout démarrer les traces logs. Ce sera utile en cas de problème (conteneur qui ne démarre pas par exemple).
heroku logs --tail -a morning-oasis-26273
Conclusion
C’était peut-être un peu plus long que prévu. Mais le tout fonctionne, bonne journée!