commit 44d1d84ca6c2f96ff25379a05ab730b1e6915ae6 Author: Nicolas Massé Date: Wed Mar 6 16:13:18 2019 +0100 initial revision diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..fde7eeb --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "theme"] + path = themes/hyde-y + url = https://github.com/enten/hyde-y.git diff --git a/archetypes/default.md b/archetypes/default.md new file mode 100644 index 0000000..00e77bd --- /dev/null +++ b/archetypes/default.md @@ -0,0 +1,6 @@ +--- +title: "{{ replace .Name "-" " " | title }}" +date: {{ .Date }} +draft: true +--- + diff --git a/config.toml b/config.toml new file mode 100644 index 0000000..8e71341 --- /dev/null +++ b/config.toml @@ -0,0 +1,8 @@ +baseURL = "/overview/" +languageCode = "en-us" +title = "3scale API Management" +theme = "hyde-y" + +[params] +topline = "Take control of your APIs, with unmatched scale, performance and flexibility!" +sidebar = "left" diff --git a/content/api-lifecycle.md b/content/api-lifecycle.md new file mode 100644 index 0000000..ee1e640 --- /dev/null +++ b/content/api-lifecycle.md @@ -0,0 +1,3 @@ +# API Lifecycle + +TODO \ No newline at end of file diff --git a/content/community.md b/content/community.md new file mode 100644 index 0000000..f3143a7 --- /dev/null +++ b/content/community.md @@ -0,0 +1,5 @@ +# Community + +Using 3scale is a great way to build real-world enterprise applications based on the latest technologies. But what if you find something that needs fixing or have a new feature to suggest? By getting involved with the 3scale community you can give feedback, improve the docs, review code and discuss and propose new features whenever they’re needed. Answering user questions or taking part in development discussions is also a great way to build a reputation for collaboration and expertise in your field. + +No matter what your skill level, contributing to 3scle can be very rewarding and a great learning experience. You’ll meet lots of smart, passionate developers who are all driven to create the best middleware possible in open source! You don’t have to be an expert to get involved and it doesn’t have to take a lot of time. diff --git a/content/docs-and-apis.md b/content/docs-and-apis.md new file mode 100644 index 0000000..ba2b038 --- /dev/null +++ b/content/docs-and-apis.md @@ -0,0 +1,50 @@ +# Docs and APIs + +There are many resources available for Red Hat 3scale API Management here on Red Hat Developer Program, and on the [Red Hat Customer Portal](https://access.redhat.com/documentation/en-us/red_hat_3scale/). On this page, we highlight our pick of those resources. + +## APIcast + +**[Deployment Options](https://access.redhat.com/documentation/en-us/red_hat_3scale/2.3/html/deployment_options/)** +Deploy APIcast API Gateway on OpenShift, natively, or using Docker. + +**[API Authentication](https://access.redhat.com/documentation/en-us/red_hat_3scale/2.3/html/api_authentication/)** +Choose your authentication pattern: API keys, app identifier and keys, or OAuth 2.0. + +**[API Devops](https://access.redhat.com/documentation/en-us/red_hat_3scale/2.3/html/api_devops/)** +How to automate the deployment of your API Gateway using Chef, production tips, and more. + +## 3scale Admin Portal + +**[Quickstart](https://access.redhat.com/documentation/en-us/red_hat_3scale/2.3/html/quickstart/)** +This guide will help you get up and running to boost your API with 3scale in no time at all. + +**[Product](https://access.redhat.com/documentation/en-us/red_hat_3scale/2.3/html/product/)** +Walkthrough of of different product features such as API integration, Analytics, Developer portal, and API environments. + +**[Accounts](https://access.redhat.com/documentation/en-us/red_hat_3scale/2.3/html/accounts/)** +How to manage admin and member rights and invite teammates to use the admin portal. + +**[Access Control](https://access.redhat.com/documentation/en-us/red_hat_3scale/2.3/html/access_control/)** +Define your API, create as many plans as you need and set up limits and pricing rules. + +**[Analytics](https://access.redhat.com/documentation/en-us/red_hat_3scale/2.3/html/analytics/)** +Share API performance insights across the organization with crisp, clear reporting. + +**[API Bizops](https://access.redhat.com/documentation/en-us/red_hat_3scale/2.3/html/api_bizops/)** +How to add / invite developers, account and application approvals, contacting developers, etc. + +## 3scale Developer Portal + +**[Developer Portal](https://access.redhat.com/documentation/en-us/red_hat_3scale/2.3/html/developer_portal/)** +A good developer portal is a must have to assure adoption of your API. Create yours in no time. + +**[API Documentation](https://access.redhat.com/documentation/en-us/red_hat_3scale/2.3/html/api_documentation/)** +Make your API documentation clear, intuitive, and user friendly with 3scale ActiveDocs. + +[See all Documentation versions](https://access.redhat.com/documentation/en-us/red_hat_3scale/) + +# Red Hat 3scale API Management Supported Configurations + +[Red Hat 3scale API Management 2.4 Supported Configurations](https://access.redhat.com/articles/2798521) + +[Red Hat 3scale API Management 2.4 Component Details](https://access.redhat.com/articles/2787991) diff --git a/content/hello-world.md b/content/hello-world.md new file mode 100644 index 0000000..3e498c6 --- /dev/null +++ b/content/hello-world.md @@ -0,0 +1,72 @@ +# Hello, World! + +## Pre-requisites: Create a token to access the Red Hat registry + +You will need to create a token to be able to fetch APIcast from the Red Hat registry. Go to [access.redhat.com/terms-based-registry](https://access.redhat.com/terms-based-registry/), log in with your developer account (if you have not already done so), and click "New Service Account." + +Give the token a name (for the rest of this article, we will use "3scale") and a meaningful description. + +Click "Create" and the generated token is displayed. Save the username and the token in a safe place for future reference. + +Click the "OpenShift Secret" tab and then "3scale-secret.yaml" to download your token in a format OpenShift will understand. Save it somewhere convenient for later use. + +![Download OpenShift Secret](/hello-world/download-openshift-secret.png) + +Click the "Docker Login" tab and copy the "docker login" command somewhere convenient for later use. + +![Copy/paste the Docker login command](/hello-world/docker-login.png) + +## Deploy APIcast on OpenShift + +To install APIcast, you will need an OpenShift instance. If your company has one, use it. If not, we recommend using [Red Hat Container Development Kit (CDK)/minishift](https://developers.redhat.com/products/cdk/hello-world/). Minishift is an OpenShift installation targeted at developers that runs on your laptop. If you need to install CDK/minishift, see [these instructions](https://developers.redhat.com/products/cdk/hello-world/). + +Spin up a minishift instance: + +```raw +$ minishift start +``` + +Create a new project for your APIcast trial: + +```raw +$ oc new-project 3scale +``` + +Inject the token you downloaded in the "Pre-requisites" section in your OpenShift project, as a secret: + +```raw +$ oc create -f ~/Downloads/*_3scale-secret.yaml +``` + +Find the name of your secret: + +```raw +$ oc get secret +NAME TYPE DATA AGE +10072637-3scale-pull-secret kubernetes.io/dockerconfigjson 1 3m +``` + +If you named your token "3scale" as suggested above, your secret should end with "-3scale-pull-secret." In this example, my secret is named "10072637-3scale-pull-secret." + +Link your token with the default service account so that any pod in this project can use it (do not forget to change "10072637-sso-pull-secret" to your token name): + +```raw +$ oc secrets link default 10072637-sso-pull-secret --for=pull +``` + +Import the APIcast ImageStream: +```raw +$ oc create -f https://raw.githubusercontent.com/3scale/3scale-amp-openshift-templates/2.4.0.GA/3scale-image-streams.yml +``` + +Import the OpenShift template: + +```raw +$ oc create -f https://raw.githubusercontent.com/3scale/3scale-amp-openshift-templates/2.4.0.GA/apicast-gateway/apicast.yml +``` + + + +### Deploy APIcast on Docker + +TODO \ No newline at end of file diff --git a/content/help.md b/content/help.md new file mode 100644 index 0000000..d4828f4 --- /dev/null +++ b/content/help.md @@ -0,0 +1,11 @@ +# Help + +## Community Q&A + +See our most popular forum discussions related to Red Hat 3scale API Management. + +![Support](/help/discussions.png) + +# Red Hat Support and Professional Services + +![Support](/help/support.png) diff --git a/content/overview.md b/content/overview.md new file mode 100644 index 0000000..e390c2e --- /dev/null +++ b/content/overview.md @@ -0,0 +1,7 @@ +--- +title: Overview +--- + +# Overview + +TODO \ No newline at end of file diff --git a/content/try-it-out.md b/content/try-it-out.md new file mode 100644 index 0000000..6466baa --- /dev/null +++ b/content/try-it-out.md @@ -0,0 +1,3 @@ +# Try it out! + +TODO \ No newline at end of file diff --git a/data/Menu.toml b/data/Menu.toml new file mode 100644 index 0000000..fec36e1 --- /dev/null +++ b/data/Menu.toml @@ -0,0 +1,21 @@ +[1-overview] + Name = "Overview" + URL = "/overview/" +[2-try-it-out] + Name = "Try it out!" + URL = "/try-it-out/" +[3-hello-world] + Name = "Hello, World!" + URL = "/hello-world/" +[4-docs] + Name = "Docs and APIs" + URL = "/docs-and-apis/" +[5-api-lifecycle] + Name = "API Lifecycle" + URL = "/api-lifecycle/" +[6-help] + Name = "Help" + URL = "/help/" +[7-community] + Name = "Community" + URL = "/community/" diff --git a/static/hello-world/create-token.png b/static/hello-world/create-token.png new file mode 100644 index 0000000..c141c28 Binary files /dev/null and b/static/hello-world/create-token.png differ diff --git a/static/hello-world/docker-login.png b/static/hello-world/docker-login.png new file mode 100644 index 0000000..7d7f173 Binary files /dev/null and b/static/hello-world/docker-login.png differ diff --git a/static/hello-world/download-openshift-secret.png b/static/hello-world/download-openshift-secret.png new file mode 100644 index 0000000..a9163c4 Binary files /dev/null and b/static/hello-world/download-openshift-secret.png differ diff --git a/static/help/discussions.png b/static/help/discussions.png new file mode 100644 index 0000000..201540d Binary files /dev/null and b/static/help/discussions.png differ diff --git a/static/help/support.png b/static/help/support.png new file mode 100644 index 0000000..ed2b4cd Binary files /dev/null and b/static/help/support.png differ diff --git a/themes/hyde-y b/themes/hyde-y new file mode 160000 index 0000000..5bbb9f8 --- /dev/null +++ b/themes/hyde-y @@ -0,0 +1 @@ +Subproject commit 5bbb9f8e65cf94f7bca87994fe585d052bedb005