Welcome to the APPUiO Public Documentation

Deprecation Notice

APPUiO Public is being discontinued. The successor to it is APPUiO Cloud. You can find the end user documentation under https://docs.appuio.cloud.

User Documentation

• Getting Started
  • Web Console
  • CLI
  • APPUiO Sample Applications
  • APPUiO - Techlab
  • OpenShift Documentation
• APPUiO Public Platform Specifics
  • Versions
  • URLs and Domains
  • Persistent Storage
  • Quotas and Limits
  • Pod count Recommendations
  • Secure Docker Builds
  • Let’s Encrypt Integration
  • Email Gateway
• APPUiO Secure Docker Builder
  • Rationale
  • Features
  • User-customizable builder configuration
  • Build VMs
  • Build Hooks
  • Multi-stage builds
  • Known Issues
• K8up (Backup Service)
  • What is K8up?
  • More about K8up
• Let’s Encrypt Integration
  • Implementation details
• How Tos
  • How to access the OpenShift registry from outside
  • How to run scheduled jobs on APPUiO
  • How to access an internal service while developing
  • How to use a private repository (on e.g. GitHub) to run S2I builds
  • How to add a persistent volume to an application
  • How to customize the build image/process
• Non HTTP Services / TCP Ingress
• Troubleshooting
  • Build
  • Deployment
  • Application Logs
• FAQ (Technical)
  • Can I run Containers/Pods as root?
  • What do we monitor?
  • What do we backup?
  • What DNS entries should I add to my custom domain?
  • Which IP addresses are being used?
  • How can I secure the access to my web application?
  • Can I run a database on APPUiO?
  • I get an error like ‘Failed Mount: MountVolume.NewMounter initialization failed for volume “gluster-pv123” : endpoints “glusterfs-cluster” not found’
  • How do I kill a pod/container
  • How do I work with a volume if my application crashes because of the data in the volume?
  • How long do we keep application logs?
  • Is OpenShift Service Catalog available to be used?
  • How to pull an image from a private registry or private docker hub
  • I’ve exhausted the number of ReplicationControllers?
  • I get an error like ‘You have reached your pull rate limit. You may increase the limit by authenticating and upgrading’

APPUiO Microservices Example

• Introduction
  • Architecture of our shop application
  • Structure of this documentation
  • Where you can find the sources
• General Concepts
  • Containers
    • Docker Compose
  • Continuous Integration
    • Jenkins
    • GitLab CI
  • OpenShift / Kubernetes
    • Source2Image
• Webserver
  • Introduction
    • Goals for CI
  • Building a container
  • Running the container
  • Implementing a CI Pipeline
    • Introduction
    • Using caching
    • Building the sources
    • Variables & Parallelization
    • Building a container
  • Preparing the APPUiO project
    • Creating an ImageStream
  • Pushing to the APPUiO registry
    • Creating a service account
    • Configuring the Kubernetes Integration (optional)
    • Extending .gitlab-ci.yml
  • Implementing a deployment strategy
    • Testing and compilation
    • Deployment to staging
    • Deployment to preprod
    • Deployment to prod
    • Creating deployments in APPUiO
  • Advanced Deployments
    • Tracking OpenShift objects
    • Using special YAML features
• API
  • Introduction
    • Goals for CI
  • Building a container
    • Creating a custom S2I builder
  • Running the container
  • Implementing a CI pipeline
    • Running tests
    • Preparing APPUiO for S2I
    • Extending the DeploymentConfig
    • Deployment to APPUiO
• Users
  • Introduction
    • Authentication principles
    • Goals for CI
  • Building a container
    • The builder image
    • The runtime image
  • Running the container
    • Compilation
    • Testing
    • Running
  • Implementing a CI Pipeline
    • Running tests
    • Compiling the application
    • Building a container
  • Deploying to APPUiO
    • Setting up an ImageStream
    • Creating DeploymentConfigs
• Orders
  • Introduction
    • Goals for CI
  • Building and running the container
  • Integrating Jenkins with APPUiO
    • Creating a slave image
    • Building the slave image
    • Adding a pod template for the slave image
    • Configuring credentials
  • Implementing a CI Pipeline
    • Scripted vs. Declarative Pipeline
    • Basic structure of a declarative pipeline
    • Implementing the test stage
    • Implementing the deployment stage
    • Deployment to multiple environments
  • Deploying to APPUiO

Application Tutorials

• Using Helm Charts to Deploy Services
  • Example: Postgres
  • Compatibility
  • Related Resources
• Custom Applications
  • Logging
  • Exception Tracking
  • Monitoring & Alerting
• PHP Source to Image Sample
• PHP Docker Build Sample App
• PHP 7 with Apache Source to Image Example
  • Build Builder
  • Deploy App
• PHP 7 with Nginx Source to Image Example
  • Build Builder
  • Deploy App
• MySql Backup Image
• PostgreSQL Backup Image (the manual way)
• Spring Boot Application
  • Dockerfile
  • Deployment
  • Configuration
• Spring Boot Application in Wildfly
  • Spring Boot Application
  • OpenShift Build Process
  • OpenShift Template
• Spring Boot Application with Angular 2 Frontend
  • Dockerfile
  • Deployment
  • Configuration
• Java EE Source to Image
  • Deployment via oc Client
  • Deployment via webconsole
  • Configuration
  • Speed up your build
• Docker Image
• Deploy Static Content to APPUiO
  • Apache based image
  • Nginx-based image
  • Continuous Integration: Trigger Rebuild
• Binary Deployment in Wildfly
  • Create a new project
  • Create the deployment folder structure
  • Create a new build using the Wildfly image
  • Start the build
  • Create a new app
  • Expose the service as route
• Node JS 6 Example
  • How to deploy to APPUiO / OpenShift Cluster
  • Database
  • Configuration
• MSSQL Server on APPUiO
  • Quick Summary
  • In Detail
• More OpenShift Sample Apps
• Prometheus
  • Installation of prometheus
  • Example Metrics from cadvisor
• Unifi-Controller

License

Indices and tables

• Index
• Search Page