Skip to content

Commit

Permalink
Codespace readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jlian authored Nov 3, 2023
1 parent ae8f1dc commit 3ae20ce
Showing 1 changed file with 20 additions and 34 deletions.
54 changes: 20 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,38 @@
# Azure IoT Operations Dev Toolbox

The AIO dev toolbox is the source of tools, samples, and other resources for customers of AIO.

## Contributing

Please view the developer guides in the docs directory to get started with contributions. Get started with the [Organization docs](./docs/ORGANIZATION.md).
This repo is the source of tools, samples, and other resources for customers of Azure IoT Operations.

## Features

This project provides the following tools:

* Pre-configured codespace with [K3s](https://k3s.io/) cluster via [K3d](https://k3d.io/)
* Krill MQTT Data Simulator
* HTTP Callout Server
* GRPC Callout Server

## Getting Started

### Prerequisites

(ideally very short, if any)

- OS
- Library version
- ...

### Installation

(ideally very short)

- npm install [package name]
- mvn install
- ...
> [!IMPORTANT]
> Codespaces are easy to setup quickly and tear down later, but they're not suitable for performance evaluation or scale testing. For those scenarios, use a validated environment from the official documentation.
>
> Azure IoT Operations is currently in preview and not recommended for production use no matter the environment.
### Quickstart
(Add steps to get up and running quickly)
## Getting Started

1. git clone [repository clone url]
2. cd [repository name]
3. ...
1. Use this GitHub codespace to explore Azure IoT Operations in your browser without installing anything on your local machine.

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Azure-Samples/aio-dev-toolbox?quickstart=1)

## Demo
1. (Optional) Enter your Azure details to store them as environment variables inside the codespace.

A demo app is included to show how to use the project.
1. Wait for the post creation commands to finish, then connect your new cluster to Azure Arc.

To run the demo, follow these steps:
```bash
az connectedk8s connect --name $CLUSTER_NAME --resource-group $RESOURCE_GROUP --subscription $SUBSCRIPTION_ID --location $REGION
```

(Add steps to start up the demo)
1. Follow Azure IoT Operations docs to finish deploying.

1.
2.
3.
1. (Add Krill and other instructions)

## Resources

Expand All @@ -59,3 +41,7 @@ To run the demo, follow these steps:
- Link to supporting information
- Link to similar sample
- ...

## Contributing

Please view the developer guides in the docs directory to get started with contributions. Get started with the [Organization docs](./docs/ORGANIZATION.md).

0 comments on commit 3ae20ce

Please sign in to comment.