Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README Updates: Clarify Kerberos Configuration #100

Open
wants to merge 46 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
fed888d
Update deploy_proxy.sh
WWitman Nov 29, 2017
efdb51d
Update README.md
WWitman Nov 29, 2017
473e1c7
Merge pull request #85 from florent-andre/documentation-fixes
WWitman Nov 30, 2017
3966393
Update package.json
WWitman Dec 1, 2017
bd064ab
Update package.json
WWitman Dec 1, 2017
2c143a2
Surround pwd argument with quotes in commands
deboraelkin2 Jan 11, 2018
042bf63
Updated repository link
deboraelkin2 Jan 11, 2018
4a3afe5
Updated version number and links to repository, issues and homepage
deboraelkin2 Jan 12, 2018
0064102
Added direct link to generator source code
deboraelkin2 Jan 14, 2018
81c391c
Added direct link to generator source code
deboraelkin2 Jan 16, 2018
62d5ab7
Added direct link to generator source code
deboraelkin2 Jan 16, 2018
fd88fc6
add troubleshooting tip
jonesfloyd Feb 21, 2018
b4bc7c7
troubleshooting edits
jonesfloyd Feb 21, 2018
f2597a0
Merge branch 'master' of github.com:apigee/api-platform-samples
DinoChiesa Mar 9, 2018
c1d7f23
update simplesoap example to use https endpoint for target and proxy
DinoChiesa Mar 9, 2018
ac8fcd2
Merge pull request #92 from DinoChiesa/master
WWitman Mar 9, 2018
32d3f7d
Merge remote-tracking branch 'refs/remotes/origin/patch-1' into patch-1
deboraelkin2 Apr 11, 2018
c93e564
Update README.md
WWitman Apr 11, 2018
0530831
Merge pull request #90 from deboraelkin2/patch-1
WWitman Apr 11, 2018
e35a235
new hosted targets exmaples
WWitman Apr 30, 2018
a31214b
New hosted targets examples.]
WWitman Apr 30, 2018
362c356
Update README.md
WWitman Apr 30, 2018
298a238
Update README.md
WWitman Apr 30, 2018
c192370
schema does not include unsupported KeyStore element
WWitman May 10, 2018
47b96a3
fixed link
WWitman May 10, 2018
169ab5b
sync schemas configs
WWitman May 11, 2018
a3a4ec0
latest xsd generated
WWitman May 22, 2018
04af847
added the jwt policy
WWitman May 22, 2018
70f559c
added note about setVariable argument
WWitman May 29, 2018
8bdb103
rezipped with latest change
WWitman May 29, 2018
e6f8501
Update README.md
WWitman Jun 19, 2018
aa0f31e
Update README.md
WWitman Jun 19, 2018
0958575
Update README.md
WWitman Jun 19, 2018
2f4feaf
Added support for the configuring TLS for the HTTP clients created by…
WWitman Jun 20, 2018
287238c
Adding readme for sample code to be added.
Aug 27, 2018
f973b39
Revert "Adding readme for sample code to be added."
Aug 27, 2018
3686b4d
Adding folder and readme for API BaaS transition samples to come.
Aug 28, 2018
9c51b89
Add what's new in the docs proxy
jonesfloyd Sep 1, 2018
2413bd3
Removing this because we’re not going to use it.
Sep 19, 2018
1b9ab82
README updates: Clarified location and permissions needed for kerbero…
Oct 15, 2018
dd8de71
README updates: Clarified location and permissions needed for kerbero…
Oct 15, 2018
19921dd
Merge branch 'kerberos-configuration' of https://github.com/jaredhwil…
Oct 15, 2018
85637ba
Merge branch 'kerberos-configuration' of https://github.com/jaredhwil…
Oct 16, 2018
b826501
Merge branch 'kerberos-configuration' of https://github.com/jaredhwil…
Oct 16, 2018
b27326a
Merge branch 'kerberos-configuration' of https://github.com/jaredhwil…
jaredhwilliams Oct 16, 2018
b7d3296
Merge branch 'kerberos-configuration' of https://github.com/jaredhwil…
jaredhwilliams Oct 16, 2018
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@
.idea/
*.iml
*.iws
*.tgz
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@

## <a name="who"></a>Audience

You are an Apigee Edge API proxy developer, or you would like to learn about developing APIs that run on Apigee Edge. At a minimum, we assume you're familiar with Apigee Edge and how to create simple API proxies. To learn more, we recommend this [getting-started tutorial](http://apigee.com/docs/api-services/tutorials/create-your-first-api).
You are an Apigee Edge API proxy developer, or you would like to learn about developing APIs that run on Apigee Edge. At a minimum, we assume you're familiar with Apigee Edge and how to create simple API proxies. To learn more, we recommend this [getting-started tutorial](https://docs.apigee.com/api-platform/tutorials/add-and-configure-your-first-api).

## <a name="intro"></a>Intro

This repository contains a collection of sample API proxies that you can deploy and run on [Apigee Edge](http://apigee.com/about/products/api-management).
This repository contains a collection of sample API proxies that you can deploy and run on [Apigee Edge](https://apigee.com/api-management/#/products).

![alt text](./images/sample-proxies-1.png)

Expand All @@ -42,7 +42,7 @@ In addition, you'll find:

## <a name="using"></a>Using the sample proxies

Most developers begin by identifying an interesting sample based on a specific use case or need. You'll find the samples in the `./api-platform-samples/sample-proxies` folder. The Apigee doc site also has a handy [samples overview page](http://apigee.com/docs/api-services/samples/samples-reference).
Most developers begin by identifying an interesting sample based on a specific use case or need. You'll find the samples in the `./api-platform-samples/sample-proxies` folder. The Apigee doc site also has a handy [samples overview page](https://docs.apigee.com/api-platform/samples/samples-reference).


For example, if you're interested in doing XML to JSON transformations, check out `api-platform-samples/sample-proxies/xmltojson`.
Expand Down Expand Up @@ -158,7 +158,7 @@ API products, apps, and developers.
Simple scripts to help you deploy the sample API proxies and profiles that they
rely on, including API products, developers, and apps.

Set you Apigee API Platform account settings in `setenv.sh` ([Register for a free Apigee account](http://eneterprise.apigee.com/signup))
Set you Apigee API Platform account settings in `setenv.sh` ([Register for a free Apigee account](https://docs.apigee.com/api-platform/get-started/creating-apigee-edge-account))

To deploy a single sample, run `deploy.sh proxyName`, where `proxyName` is the name of the directory under `/sample-proxies` that contains the proxy you want to deploy.

Expand All @@ -178,7 +178,7 @@ To deploy all samples and API products, run `deploy_all.sh`

## <a name="docs"></a>Apigee Edge documentation

The Apigee Edge docs are [here](http://apigee.com/docs).
The Apigee Edge docs are [here](https://docs.apigee.com).

---

Expand Down
3 changes: 3 additions & 0 deletions doc-samples/hosted-targets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
This directory contains samples that you can deploy on Apigee Edge Hosted Targets. See the README files for detailed instructions.

To learn about Hosted Targets, see [Hosted Targets overview](https://docs.apigee.com/api-platform/hosted-targets/hosted-targets-overview.html) in the Apigee Edge documentation.
102 changes: 102 additions & 0 deletions doc-samples/hosted-targets/node-hosted-express/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# How to create a hello world Node.js application with Hosted Targets using express

This sample is a Node.js proxy that uses [express](https://www.npmjs.com/package/express).

## Test the app locally
Before pushing to Apigee, it can be useful to test the application locally first to make sure everything is working as it should.

1. Make sure you have [Nodejs](https://nodejs.org/en/download/) installed
2. Installl dependencies:

```
cd apiproxy/resources/hosted
npm install
```

3. Start the application:

```
PORT=8081 node index.js
```

4. Test the applicaiton:

```
curl http://localhost:8081
{"hello":"Hello World!"}

curl http://localhost:8081/hello/user
{"hello":"hello user"}
```

5. Remove node_modules and package-lock.json:

```
rm -rf node_modules
rm package-lock.json
```

6. Go back to the home directory for deploying:

```
cd ../../..
```

## Deploy the proxy
1. Make sure you have [apigeetool](https://github.com/apigee/apigeetool-node) installed
2. Make sure you have [get_token](https://apidocs.apigee.com/api-reference/content/using-oauth2-security-apigee-edge-management-api) script installed
3. Deploy your proxy:

```
get_token && apigeetool deployproxy \
-o <apigee org> \
-e <apigee env> \
--json \
--token "$(< ~/.sso-cli/valid_token.dat)" \
--api node-hosted-express \
--directory .
```
**Note**: This step might take a minute or two to work

4. Test your proxy deployment:

```
curl https:/<apigee org>-<apigee env>.apigee.net/node-hosted-express
```

5. Undeploy your proxy:

```
get_token && apigeetool undeploy \
-o <apigee org> \
-e <apigee env> \
--json \
--token "$(< ~/.sso-cli/valid_token.dat)" \
--api node-hosted-express \
--revision <revision to undeploy e.g 1>
```

For more insight into Hosted Targets and Apigee, visit our [documentation](https://docs.apigee.com/api-platform/hosted-targets/hosted-targets-overview.html).

# Ask the community

[![alt text](../../../images/apigee-community.png "Apigee Community is a great place to ask questions and find answers about developing API proxies. ")](https://community.apigee.com?via=github)

---

Copyright © 2017 Apigee Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy
of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

http://docs.apigee.com/api-services/reference/supported-software

Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIProxy revision="1" name="node-hosted-express">
<Basepaths>/node-hosted-express</Basepaths>
<ConfigurationVersion majorVersion="4" minorVersion="0"/>
<CreatedAt>1512506918706</CreatedAt>
<CreatedBy>[email protected]</CreatedBy>
<Description></Description>
<DisplayName>node-hosted-express</DisplayName>
<LastModifiedAt>1512506918706</LastModifiedAt>
<LastModifiedBy>[email protected]</LastModifiedBy>
<Policies/>
<ProxyEndpoints>
<ProxyEndpoint>default</ProxyEndpoint>
</ProxyEndpoints>
<Resources>
<Resource>hosted://app.yaml</Resource>
<Resource>hosted://index.js</Resource>
<Resource>hosted://package.json</Resource>
</Resources>
<Spec></Spec>
<TargetServers/>
<TargetEndpoints>
<TargetEndpoint>default</TargetEndpoint>
</TargetEndpoints>
</APIProxy>
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProxyEndpoint name="default">
<Description/>
<FaultRules/>
<PreFlow name="PreFlow">
<Request/>
<Response/>
</PreFlow>
<PostFlow name="PostFlow">
<Request/>
<Response/>
</PostFlow>
<Flows/>
<HTTPProxyConnection>
<BasePath>/node-hosted-express</BasePath>
<Properties/>
<VirtualHost>default</VirtualHost>
<VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>
<RouteRule name="default">
<TargetEndpoint>default</TargetEndpoint>
</RouteRule>
</ProxyEndpoint>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
runtime: node
runtimeVersion: 8
application: my-express-app
env:
- name: NODE_ENV
value: production
- name: LOG_LEVEL
value: 3
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
var express = require('express')
var app = express()

app.get('/', function (req, res) {
res.json({ hello: "Hello World!" })
})

app.get('/hello/:name', function (req, res) {
var name = req.params.name
res.json({ hello: "hello " + name })
})

var server = app.listen(process.env.PORT || 9000, function () {
console.log('Listening on port %d', server.address().port)
})
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"name": "hello-world",
"version": "1.0.0",
"main": "index.js",
"scripts": {
"start": "node index.js --use_strict"
},
"author": "",
"license": "",
"dependencies": {
"express": "^4.16.0"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TargetEndpoint name="default">
<Description/>
<FaultRules/>
<PreFlow name="PreFlow">
<Request/>
<Response/>
</PreFlow>
<PostFlow name="PostFlow">
<Request/>
<Response/>
</PostFlow>
<Flows/>
<HostedTarget/>
</TargetEndpoint>
7 changes: 7 additions & 0 deletions doc-samples/hosted-targets/node-hosted-express/deploy.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
get_token && apigeetool deployproxy \
-o apigee-hf-testing \
-e test \
--json \
--token "$(< ~/.sso-cli/valid_token.dat)" \
--api node-hosted-express \
--directory .
80 changes: 80 additions & 0 deletions doc-samples/hosted-targets/node-hosted-hello/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# How to create a hello world Node.js application with Hosted Targets

This sample is a simple hello world Node.js proxy.

## Test the app locally
Before pushing to Apigee, it can be useful to test the application locally first to make sure everything is working as it should.

1. Make sure you have [Nodejs](https://nodejs.org/en/download/) installed

2. Start the application:

```
PORT=8081 node apiproxy/resources/hosted/index.js
```

3. Test the applicaiton:

```
curl http://localhost:8081
{"date":"2018-03-12T21:45:22.161Z","msg":"Hello, World!"}
```

## Deploy the proxy
1. Make sure you have [apigeetool](https://github.com/apigee/apigeetool-node) installed
2. Make sure you have [get_token](https://apidocs.apigee.com/api-reference/content/using-oauth2-security-apigee-edge-management-api) script installed
3. Deploy your proxy:

```
get_token && apigeetool deployproxy \
-o <apigee org> \
-e <apigee env> \
--json \
--token "$(< ~/.sso-cli/valid_token.dat)" \
--api node-hosted-hello \
--directory .
```
**Note**: This step might take a minute or two to work

4. Test your proxy deployment:

```
curl https:/<apigee org>-<apigee env>.apigee.net/node-hosted-hello
```

5. Undeploy your proxy:

```
get_token && apigeetool undeploy \
-o <apigee org> \
-e <apigee env> \
--json \
--token "$(< ~/.sso-cli/valid_token.dat)" \
--api node-hosted-hello \
--revision <revision to undeploy e.g 1>
```

For more insight into Hosted Targets and Apigee, visit our [documentation](https://docs.apigee.com/api-platform/hosted-targets/hosted-targets-overview.html).

# Ask the community

[![alt text](../../../images/apigee-community.png "Apigee Community is a great place to ask questions and find answers about developing API proxies. ")](https://community.apigee.com?via=github)

---

Copyright © 2017 Apigee Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy
of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

http://docs.apigee.com/api-services/reference/supported-software

Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<APIProxy revision="1" name="node-hosted-hello">
<Basepaths>/node-hosted-hello</Basepaths>
<ConfigurationVersion majorVersion="4" minorVersion="0"/>
<CreatedAt>1512506918706</CreatedAt>
<CreatedBy>[email protected]</CreatedBy>
<Description></Description>
<DisplayName>node-hosted-hello</DisplayName>
<LastModifiedAt>1512506918706</LastModifiedAt>
<LastModifiedBy>[email protected]</LastModifiedBy>
<Policies/>
<ProxyEndpoints>
<ProxyEndpoint>default</ProxyEndpoint>
</ProxyEndpoints>
<Resources>
<Resource>hosted://app.yaml</Resource>
<Resource>hosted://index.js</Resource>
<Resource>hosted://package.json</Resource>
</Resources>
<Spec></Spec>
<TargetServers/>
<TargetEndpoints>
<TargetEndpoint>default</TargetEndpoint>
</TargetEndpoints>
</APIProxy>
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProxyEndpoint name="default">
<Description/>
<FaultRules/>
<PreFlow name="PreFlow">
<Request/>
<Response/>
</PreFlow>
<PostFlow name="PostFlow">
<Request/>
<Response/>
</PostFlow>
<Flows/>
<HTTPProxyConnection>
<BasePath>/node-hosted-hello</BasePath>
<Properties/>
<VirtualHost>default</VirtualHost>
<VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>
<RouteRule name="default">
<TargetEndpoint>default</TargetEndpoint>
</RouteRule>
</ProxyEndpoint>
Loading