Skip to content

Commit

Permalink
move non python s2i to incubating (#1099)
Browse files Browse the repository at this point in the history
  • Loading branch information
ukclivecox authored and axsaucedo committed Nov 15, 2019
1 parent 941a816 commit 0c64f87
Show file tree
Hide file tree
Showing 68 changed files with 22 additions and 22 deletions.
16 changes: 8 additions & 8 deletions doc/source/R/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Packaging an R model for Seldon Core using s2i
# Packaging an R model for Seldon Core using s2i (incubating)

In this guide, we illustrate the steps needed to wrap your own R model in a docker image ready for deployment with Seldon Core using [source-to-image app s2i](https://github.com/openshift/source-to-image). If you prefer to use plain Docker, see the [Docker instructions](r_wrapping_docker.md).

Expand Down Expand Up @@ -30,7 +30,7 @@ We will go into detail for each of these steps:

### R Runtime Model file

Your source code should contain an R file which defines an S3 class for your model. For example, looking at our skeleton R model file at `wrappers/s2i/R/test/model-template-app/MyModel.R`:
Your source code should contain an R file which defines an S3 class for your model. For example, looking at our skeleton R model file at `incubating/wrappers/s2i/R/test/model-template-app/MyModel.R`:

```R
library(methods)
Expand Down Expand Up @@ -91,12 +91,12 @@ s2i build <src-folder> seldonio/seldon-core-s2i-r:0.1 <my-image-name>
An example invocation using the test template model inside seldon-core:

```bash
s2i build https://github.com/seldonio/seldon-core.git --context-dir=wrappers/s2i/R/test/model-template-app seldonio/seldon-core-s2i-r:0.1 seldon-core-template-model
s2i build https://github.com/seldonio/seldon-core.git --context-dir=incubating/wrappers/s2i/R/test/model-template-app seldonio/seldon-core-s2i-r:0.1 seldon-core-template-model
```

The above s2i build invocation:

- uses the GitHub repo: https://github.com/seldonio/seldon-core.git and the directory `wrappers/s2i/R/test/model-template-app` inside that repo.
- uses the GitHub repo: https://github.com/seldonio/seldon-core.git and the directory `incubating/wrappers/s2i/R/test/model-template-app` inside that repo.
- uses the builder image `seldonio/seldon-core-s2i-r`
- creates a docker image `seldon-core-template-model`

Expand All @@ -105,7 +105,7 @@ For building from a local source folder, an example where we clone the seldon-co
```bash
git clone https://github.com/seldonio/seldon-core.git
cd seldon-core
s2i build wrappers/s2i/R/test/model-template-app seldonio/seldon-core-s2i-r:0.1 seldon-core-template-model
s2i build incubating/wrappers/s2i/R/test/model-template-app seldonio/seldon-core-s2i-r:0.1 seldon-core-template-model
```

For more help see:
Expand Down Expand Up @@ -145,12 +145,12 @@ Can only by 0 at present. In future, will allow the state of the component to be

#### MODEL

- [A minimal skeleton for model source code](https://github.com/cliveseldon/seldon-core/tree/s2i/wrappers/s2i/R/test/model-template-app)
- [A minimal skeleton for model source code](https://github.com/seldonio/seldon-core/tree/incubating/wrappers/s2i/R/test/model-template-app)
- [Example models](../examples/notebooks.html)

#### ROUTER
- [A minimal skeleton for router source code](https://github.com/cliveseldon/seldon-core/tree/s2i/wrappers/s2i/R/test/router-template-app)
- [A minimal skeleton for router source code](https://github.com/seldonio/seldon-core/tree/incubating/wrappers/s2i/R/test/router-template-app)

#### TRANSFORMER

- [A minimal skeleton for transformer source code](https://github.com/cliveseldon/seldon-core/tree/s2i/wrappers/s2i/R/test/transformer-template-app)
- [A minimal skeleton for transformer source code](https://github.com/seldonio/seldon-core/tree/incubating/wrappers/s2i/R/test/transformer-template-app)
10 changes: 5 additions & 5 deletions doc/source/R/r_wrapping_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You will need an R file which provides an S3 class for your model via an `initia

### R Runtime Model file

Your source code should contain an R file which defines an S3 class for your model. For example, looking at our skeleton R model file at `wrappers/s2i/R/test/model-template-app/MyModel.R`:
Your source code should contain an R file which defines an S3 class for your model. For example, looking at our skeleton R model file at `incubating/wrappers/s2i/R/test/model-template-app/MyModel.R`:

```R
library(methods)
Expand Down Expand Up @@ -73,7 +73,7 @@ RUN mkdir microservice
COPY . /microservice
WORKDIR /microservice
RUN curl -OL https://raw.githubusercontent.com/SeldonIO/seldon-core/v0.2.7/wrappers/s2i/R/microservice.R > /microservice/microservice.R
RUN curl -OL https://raw.githubusercontent.com/SeldonIO/seldon-core/v0.5.0/incubating/wrappers/s2i/R/microservice.R > /microservice/microservice.R
EXPOSE 5000
Expand Down Expand Up @@ -118,12 +118,12 @@ Can only by 0 at present. In future, will allow the state of the component to be

#### MODEL

- [A minimal skeleton for model source code](https://github.com/cliveseldon/seldon-core/tree/s2i/wrappers/s2i/R/test/model-template-app)
- [A minimal skeleton for model source code](https://github.com/seldonio/seldon-core/tree/incubating/wrappers/s2i/R/test/model-template-app)
- [Example models](../examples/notebooks.html)

#### ROUTER
- [A minimal skeleton for router source code](https://github.com/cliveseldon/seldon-core/tree/s2i/wrappers/s2i/R/test/router-template-app)
- [A minimal skeleton for router source code](https://github.com/seldonio/seldon-core/tree/incubating/wrappers/s2i/R/test/router-template-app)

#### TRANSFORMER

- [A minimal skeleton for transformer source code](https://github.com/cliveseldon/seldon-core/tree/s2i/wrappers/s2i/R/test/transformer-template-app)
- [A minimal skeleton for transformer source code](https://github.com/seldonio/seldon-core/tree/incubating/wrappers/s2i/R/test/transformer-template-app)
10 changes: 5 additions & 5 deletions doc/source/java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Create a Spring Boot Maven project and include the dependency:
</dependency>
```

A full example can be found at ```wrappers/s2i/java/test/model-template-app/pom.xml```.
A full example can be found at ```incubating/wrappers/s2i/java/test/model-template-app/pom.xml```.

### Spring Boot Intialization

Expand Down Expand Up @@ -156,12 +156,12 @@ s2i build <src-folder> seldonio/seldon-core-s2i-java-build:0.1 <my-image-name> -
An example invocation using the test template model inside seldon-core:

```bash
s2i build https://github.com/seldonio/seldon-core.git --context-dir=wrappers/s2i/python/test/model-template-app seldonio/seldon-core-s2i-java-build:0.1 h2o-test:0.1 --runtime-image seldonio/seldon-core-s2i-java-runtime:0.1
s2i build https://github.com/seldonio/seldon-core.git --context-dir=incubating/wrappers/s2i/python/test/model-template-app seldonio/seldon-core-s2i-java-build:0.1 h2o-test:0.1 --runtime-image seldonio/seldon-core-s2i-java-runtime:0.1
```

The above s2i build invocation:

* uses the GitHub repo: https://github.com/seldonio/seldon-core.git and the directory ```wrappers/s2i/R/test/model-template-app``` inside that repo.
* uses the GitHub repo: https://github.com/seldonio/seldon-core.git and the directory ```incubating/wrappers/s2i/java/test/model-template-app``` inside that repo.
* uses the builder image ```seldonio/seldon-core-s2i-java-build```
* uses the runtime image ```seldonio/seldon-core-s2i-java-runtime```
* creates a docker image ```seldon-core-template-model```
Expand All @@ -172,7 +172,7 @@ For building from a local source folder, an example where we clone the seldon-co
```bash
git clone https://github.com/seldonio/seldon-core.git
cd seldon-core
s2i build wrappers/s2i/R/test/model-template-app seldonio/seldon-core-s2i-java-build:0.1 h2o-test:0.1 --runtime-image seldonio/seldon-core-s2i-java-runtime:0.1
s2i build incubating/wrappers/s2i/java/test/model-template-app seldonio/seldon-core-s2i-java-build:0.1 h2o-test:0.1 --runtime-image seldonio/seldon-core-s2i-java-runtime:0.1
```

For more help see:
Expand Down Expand Up @@ -206,7 +206,7 @@ The service type being created. Available options are:

### MODEL

* [A minimal skeleton for model source code](https://github.com/cliveseldon/seldon-core/tree/s2i/wrappers/s2i/java/test/model-template-app)
* [A minimal skeleton for model source code](https://github.com/seldonio/seldon-core/tree/incubating/wrappers/s2i/java/test/model-template-app)
* [Example H2O MOJO](../examples/h2o_mojo.html)


Expand Down
6 changes: 3 additions & 3 deletions doc/source/nodejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,12 @@ s2i build <src-folder> seldonio/seldon-core-s2i-nodejs:0.1 <my-image-name>
An example invocation using the test template model inside seldon-core:

```bash
s2i build https://github.com/seldonio/seldon-core.git --context-dir=wrappers/s2i/nodejs/test/model-template-app seldonio/seldon-core-s2i-nodejs:0.1 seldon-core-template-model
s2i build https://github.com/seldonio/seldon-core.git --context-dir=incubating/wrappers/s2i/nodejs/test/model-template-app seldonio/seldon-core-s2i-nodejs:0.1 seldon-core-template-model
```

The above s2i build invocation:

- uses the GitHub repo: https://github.com/seldonio/seldon-core.git and the directory `wrappers/s2i/nodejs/test/model-template-app` inside that repo.
- uses the GitHub repo: https://github.com/seldonio/seldon-core.git and the directory `incubating/wrappers/s2i/nodejs/test/model-template-app` inside that repo.
- uses the builder image `seldonio/seldon-core-s2i-nodejs`
- creates a docker image `seldon-core-template-model`

Expand All @@ -114,7 +114,7 @@ For building from a local source folder, an example where we clone the seldon-co
```bash
git clone https://github.com/seldonio/seldon-core.git
cd seldon-core
s2i build wrappers/s2i/nodejs/test/model-template-app seldonio/seldon-core-s2i-nodejs:0.1 seldon-core-template-model
s2i build incubating/wrappers/s2i/nodejs/test/model-template-app seldonio/seldon-core-s2i-nodejs:0.1 seldon-core-template-model
```

For more help see:
Expand Down
2 changes: 1 addition & 1 deletion doc/source/tutorials/openshift_s2i.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ s2i build <src-folder> seldonio/seldon-core-s2i-r <my-image-name>
An example invocation using the test template model inside seldon-core:

```bash
s2i build https://github.com/seldonio/seldon-core.git --context-dir=wrappers/s2i/R/test/model-template-app seldonio/seldon-core-s2i-r seldon-core-template-model
s2i build https://github.com/seldonio/seldon-core.git --context-dir=incubating/wrappers/s2i/R/test/model-template-app seldonio/seldon-core-s2i-r seldon-core-template-model
```

## Java
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 0c64f87

Please sign in to comment.