Best practices to maintain proxies in GIT

Hi All,

what are the best practices to maintain proxies in the git.we use bitbucket.

we have like 30 proxies and we arranged in the below format.

1) In bitbucket we have a project called xyz,inside that we have the below structure.

Project repo name folders

Department name app name api/proxy name(multiple folders, each folder representing proxy name)

2)Developers write code and exports the proxy as zip file with version like below

poc-deploy-automation_rev2_2019_01_14.zip

3) The proxy folder name will be like above.

questions:

1)Is the above way a best way to maintain?

2) is it better to have proxy names as repo names inside a bitbucket project?

3)we will have a situation where we may deploy one proxy or multiple proxies, we cant be sure of that.

4)if we maintain the folder names as proxy names with revision number, will it be a problem.?

Note: we using jenkins and apigeetool to automate not maven.

Solved Solved
0 1 1,223
1 ACCEPTED SOLUTION

@NAGA SAKETH JALIGAMA

You can check an earlier post which provides good info on how to do source control for the API proxy development in Apigee

https://community.apigee.com/articles/34868/source-control-for-api-proxy-development.html

#2 In my earlier Apigee implementations, we had one repo per api proxy. the repo names were kept same as the api proxy for simplicity and easier identification

#3 If you have one proxy per repo, you can easily control the deployment of the proxies. You can maintain a jenkins build file in each api proxy repo. The deployment will be triggered when you push to the repo

#4 If you have revision numbers appended to the folders, it can become difficult to maintain and track the changes and deployemnts to different environments over a period of time. Instead you can use the branching and labels in bitbucket to track your revisions

Note: The answers to your questions wont differ whether you use apigeetool or maven plugin for deployment. They are just deployment plugins that you configure and setup your build pipeline with. The deployment commands may vary, but your source control configuration will not change due to that.

View solution in original post

1 REPLY 1

@NAGA SAKETH JALIGAMA

You can check an earlier post which provides good info on how to do source control for the API proxy development in Apigee

https://community.apigee.com/articles/34868/source-control-for-api-proxy-development.html

#2 In my earlier Apigee implementations, we had one repo per api proxy. the repo names were kept same as the api proxy for simplicity and easier identification

#3 If you have one proxy per repo, you can easily control the deployment of the proxies. You can maintain a jenkins build file in each api proxy repo. The deployment will be triggered when you push to the repo

#4 If you have revision numbers appended to the folders, it can become difficult to maintain and track the changes and deployemnts to different environments over a period of time. Instead you can use the branching and labels in bitbucket to track your revisions

Note: The answers to your questions wont differ whether you use apigeetool or maven plugin for deployment. They are just deployment plugins that you configure and setup your build pipeline with. The deployment commands may vary, but your source control configuration will not change due to that.