|
1 | | -# Project Name |
| 1 | +# Azure Service Operator Samples |
2 | 2 |
|
3 | | -(short, 1-3 sentenced, description of the project) |
| 3 | +This project contains example uses of the Azure Service Operator. These examples show how to deploy Azure services alongside your Kubernetes deployments. |
4 | 4 |
|
5 | | -## Features |
| 5 | +## Examples |
6 | 6 |
|
7 | | -This project framework provides the following features: |
| 7 | +The example deployments currently contained in this repository: |
8 | 8 |
|
9 | | -* Feature 1 |
10 | | -* Feature 2 |
| 9 | +* [azure-votes-sql](./azure-votes-sql) - example Gp web app using Azure SQL Server |
| 10 | +* [wordpress-demo](./wordpress-demo) - example deploying Wordpress with Azure Databases for MySQL |
11 | 11 | * ... |
12 | 12 |
|
13 | 13 | ## Getting Started |
14 | 14 |
|
15 | 15 | ### Prerequisites |
16 | 16 |
|
17 | | -(ideally very short, if any) |
| 17 | +- Kubernetes cluster |
| 18 | + - Local: [Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube) |
| 19 | + - [Kind](https://github.com/kubernetes-sigs/kind), or, |
| 20 | + - [Docker for desktop](https://blog.docker.com/2018/07/kubernetes-is-now-available-in-docker-desktop-stable-channel/). |
| 21 | + - Or in the cloud: [Azure Kubernetes Service](https://azure.microsoft.com/en-us/services/kubernetes-service/) |
18 | 22 |
|
19 | | -- OS |
20 | | -- Library version |
| 23 | +- [Azure Service Operator](https://github.com/Azure/azure-service-operator) |
21 | 24 | - ... |
22 | 25 |
|
23 | 26 | ### Installation |
24 | 27 |
|
25 | | -(ideally very short) |
| 28 | +Go to the directory containing the example you would like to try. Follow the readme there. |
26 | 29 |
|
27 | | -- npm install [package name] |
28 | | -- mvn install |
29 | | -- ... |
30 | | - |
31 | | -### Quickstart |
32 | | -(Add steps to get up and running quickly) |
33 | | - |
34 | | -1. git clone [repository clone url] |
35 | | -2. cd [respository name] |
36 | | -3. ... |
37 | | - |
38 | | - |
39 | | -## Demo |
40 | | - |
41 | | -A demo app is included to show how to use the project. |
42 | | - |
43 | | -To run the demo, follow these steps: |
44 | | - |
45 | | -(Add steps to start up the demo) |
46 | | - |
47 | | -1. |
48 | | -2. |
49 | | -3. |
50 | | - |
51 | | -## Resources |
52 | | - |
53 | | -(Any additional resources or related projects) |
54 | | - |
55 | | -- Link to supporting information |
56 | | -- Link to similar sample |
57 | | -- ... |
0 commit comments