summaryrefslogtreecommitdiffstats
path: root/release-notes/src/main/asciidoc/devel_guide
diff options
context:
space:
mode:
authorJan Srnicek <jsrnicek@cisco.com>2017-01-26 13:03:21 +0100
committerJan Srnicek <jsrnicek@cisco.com>2017-02-23 06:19:17 +0000
commit4c4bb0911d3556c834fd384aa1ef7c4d4ce69a33 (patch)
tree32814af89a96c030aab04c50f446c809547459cb /release-notes/src/main/asciidoc/devel_guide
parent7cfeff1c19a3dc670e1352ca15d1f8d6d568cae4 (diff)
HONEYCOMB-269 - Release notes update
- Update features list, postman collections,models,etc ... - Provides samples sources mentioned in devel_plugin_vpp_tutorial -Broken links fixed Change-Id: I549fcec7c4e7e669cba44cafd12d824e63473533 Signed-off-by: Marek Gradzki <mgradzki@cisco.com> Signed-off-by: Jan Srnicek <jsrnicek@cisco.com>
Diffstat (limited to 'release-notes/src/main/asciidoc/devel_guide')
-rw-r--r--release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc295
1 files changed, 153 insertions, 142 deletions
diff --git a/release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc b/release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc
index ee148e5e5..c55e85ccc 100644
--- a/release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc
+++ b/release-notes/src/main/asciidoc/devel_guide/devel_plugin_vpp_tutorial.adoc
@@ -73,12 +73,23 @@ Also add vpp-translate-utils dependency so that writing translation code is easi
[source,xml,subs="+attributes"]
----
<dependency>
- <groupId>io.fd.honeycomb.vpp</groupId>
+ <groupId>io.fd.hc2vpp.vpp</groupId>
<artifactId>vpp-translate-utils</artifactId>
<version>{project-version}</version>
</dependency>
----
+To use advanced features such as context caching, use dependency to translate-utils
+
+[source,xml,subs="+attributes"]
+----
+<dependency>
+ <groupId>io.fd.honeycomb</groupId>
+ <artifactId>translate-utils</artifactId>
+ <version>${project.version}</version>
+</dependency>
+----
+
Do not rebuild yet, since the APIs for this plugin have changed and the compilation would fail. But make sure to update the project if using an IDE to pick up the Jvpp dependency.
=== Updating the customizers
@@ -91,36 +102,50 @@ Rename it to VxlanReadCustomzier. Update the code to:
[source,java]
----
-package io.fd.honeycomb.tutorial.read;
+package io.fd.hc2vpp.samples.read;
+
+import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
+import io.fd.hc2vpp.common.translate.util.AddressTranslator;
+import io.fd.hc2vpp.common.translate.util.ByteDataTranslator;
+import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
import io.fd.honeycomb.translate.read.ReadContext;
import io.fd.honeycomb.translate.read.ReadFailedException;
import io.fd.honeycomb.translate.spi.read.ListReaderCustomizer;
-import io.fd.honeycomb.translate.v3po.util.NamingContext;
-import io.fd.honeycomb.translate.v3po.util.TranslateUtils;
-import java.util.Collections;
-import java.util.List;
-import java.util.stream.Collectors;
-import javax.annotation.Nonnull;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.sample.plugin.params.VxlansBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.sample.plugin.params.vxlans.VxlanTunnel;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.sample.plugin.params.vxlans.VxlanTunnelBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.sample.plugin.params.vxlans.VxlanTunnelKey;
+import io.fd.honeycomb.translate.util.read.cache.DumpCacheManager;
+import io.fd.vpp.jvpp.core.dto.VxlanTunnelDetails;
+import io.fd.vpp.jvpp.core.dto.VxlanTunnelDetailsReplyDump;
+import io.fd.vpp.jvpp.core.dto.VxlanTunnelDump;
+import io.fd.vpp.jvpp.core.future.FutureJVppCore;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.sample.plugin.params.VxlansBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.sample.plugin.params.vxlans.VxlanTunnel;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.sample.plugin.params.vxlans.VxlanTunnelBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.sample.plugin.params.vxlans.VxlanTunnelKey;
import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
-import org.openvpp.jvpp.VppBaseCallException;
-import org.openvpp.jvpp.core.dto.VxlanTunnelDetails;
-import org.openvpp.jvpp.core.dto.VxlanTunnelDetailsReplyDump;
-import org.openvpp.jvpp.core.dto.VxlanTunnelDump;
-import org.openvpp.jvpp.core.future.FutureJVppCore;
+
+import javax.annotation.Nonnull;
+import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
+
/**
* Reader for {@link VxlanTunnel} list node from our YANG model.
*/
public final class VxlanReadCustomizer implements
- ListReaderCustomizer<VxlanTunnel, VxlanTunnelKey, VxlanTunnelBuilder> {
+ ListReaderCustomizer<VxlanTunnel, VxlanTunnelKey, VxlanTunnelBuilder>,
+ // provides utility methods to translate binary data
+ ByteDataTranslator,
+ // provides utility methods to translate Ipv4,Ipv6,Mac addresses.
+ // in case that just one address family processing is needed,use *address-family-name*Translator,
+ // for ex Ipv4Translator
+ AddressTranslator,
+ // provides utility methods to consume results of jvpp api calls
+ JvppReplyConsumer {
// JVpp core. This is the Java API for VPP's core API.
private final FutureJVppCore jVppCore;
@@ -135,9 +160,38 @@ public final class VxlanReadCustomizer implements
// backed by context storage that makes the lookup and storing easier.
private final NamingContext vxlanNamingContext;
+ // Dump manager that provides intelligent caching based on provided contextual key
+ private DumpCacheManager<VxlanTunnelDetailsReplyDump, Integer> dumpManager;
+
public VxlanReadCustomizer(final FutureJVppCore jVppCore, final NamingContext vxlanNamingContext) {
this.jVppCore = jVppCore;
this.vxlanNamingContext = vxlanNamingContext;
+
+ this.dumpManager = new DumpCacheManager.DumpCacheManagerBuilder<VxlanTunnelDetailsReplyDump, Integer>()
+ // executor handles dumping of data itself, based on provided lambda
+ // instanceIdentifier - identifier of entity that we are caching, should be the one passed as parameter
+ // to getAllIds or readCurrentAttributes. Caching is by default performed based on this key
+ // param - can be anything that needs to be bind to request
+ .withExecutor((instanceIdentifier, param) -> {
+ // creates dump request
+ final VxlanTunnelDump vxlanTunnelDump = new VxlanTunnelDump();
+ // binds parameters, in this case index of interface
+ vxlanTunnelDump.swIfIndex = param;
+ // perform dump action with default timeout and either return result or throw ReadFailedException
+ // identified by provided instanceIdentifier
+ return getReplyForRead(jVppCore.vxlanTunnelDump(vxlanTunnelDump).toCompletableFuture(), instanceIdentifier);
+ })
+ // this provides type-awareness for caching, so multiple DumpManagers can be used withing the same
+ // customizer, using same instance identifiers, as long as they handle different data types
+ .acceptOnly(VxlanTunnelDetailsReplyDump.class)
+
+ // either acceptOnly is required or custom cache key factory must be provided to tell manager,
+ // how to produce keys. can be used to change caching scope of data
+ //.withCacheKeyFactory()
+
+ // serves as post-dump processing of any kind, triggered only once after calling executor
+ //.withPostProcessingFunction()
+ .build();
}
/**
@@ -148,24 +202,14 @@ public final class VxlanReadCustomizer implements
public List<VxlanTunnelKey> getAllIds(@Nonnull final InstanceIdentifier<VxlanTunnel> id,
@Nonnull final ReadContext context)
throws ReadFailedException {
- // Create Dump request
- final VxlanTunnelDump vxlanTunnelDump = new VxlanTunnelDump();
- // Set Dump request attributes
- // Set interface index to 0, so all interfaces are dumped and we can get the list of all IDs
- vxlanTunnelDump.swIfIndex = 0;
- final VxlanTunnelDetailsReplyDump reply;
- try {
- reply = TranslateUtils.getReplyForRead(jVppCore.vxlanTunnelDump(vxlanTunnelDump).toCompletableFuture(), id);
- } catch (VppBaseCallException e) {
- throw new ReadFailedException(id, e);
- }
- // Check for empty response (no vxlan tunnels to read)
- if (reply == null || reply.vxlanTunnelDetails == null) {
+ final Optional<VxlanTunnelDetailsReplyDump> dump = dumpManager.getDump(id, context.getModificationCache(), 0);
+
+ if (!dump.isPresent()) {
return Collections.emptyList();
}
- return reply.vxlanTunnelDetails.stream()
+ return dump.get().vxlanTunnelDetails.stream()
// Need a name of an interface here. Use context to look it up from index
// In case the naming context does not contain such mapping, it creates an artificial one
.map(a -> new VxlanTunnelKey(vxlanNamingContext.getName(a.swIfIndex, context.getMappingContext())))
@@ -196,31 +240,23 @@ public final class VxlanReadCustomizer implements
// The ID received here contains the name of a particular interface that should be read
// It was either requested directly by HC users or is one of the IDs from getAllIds that could have been invoked
// just before this method invocation
+ final String vxlanName = id.firstKeyOf(VxlanTunnel.class).getId();
- // Create Dump request
- final VxlanTunnelDump vxlanTunnelDump = new VxlanTunnelDump();
- // Set Dump request attributes
- // Set the vxlan index from naming context
// Naming context must contain the mapping because:
// 1. The vxlan tunnel was created in VPP using HC + this plugin meaning we stored the mapping in write customizer
// 2. The vxlan tunnel was already present in VPP, but HC reconciliation mechanism took care of that (as long as proper Initializer is provided by this plugin)
- final String vxlanName = id.firstKeyOf(VxlanTunnel.class).getId();
- vxlanTunnelDump.swIfIndex = vxlanNamingContext.getIndex(vxlanName, ctx.getMappingContext());
- final VxlanTunnelDetailsReplyDump reply;
- try {
- reply = TranslateUtils.getReplyForRead(jVppCore.vxlanTunnelDump(vxlanTunnelDump).toCompletableFuture(), id);
- } catch (VppBaseCallException e) {
- throw new ReadFailedException(id, e);
- }
+ final Optional<VxlanTunnelDetailsReplyDump> dump = dumpManager.getDump(id, ctx.getModificationCache(),
+ vxlanNamingContext.getIndex(vxlanName, ctx.getMappingContext()));
+
- Preconditions.checkState(reply != null && reply.vxlanTunnelDetails != null);
- final VxlanTunnelDetails singleVxlanDetail = reply.vxlanTunnelDetails.stream().findFirst().get();
+ Preconditions.checkState(dump.isPresent() && dump.get().vxlanTunnelDetails != null);
+ final VxlanTunnelDetails singleVxlanDetail = dump.get().vxlanTunnelDetails.stream().findFirst().get();
// Now translate all attributes into provided builder
- final Boolean isIpv6 = TranslateUtils.byteToBoolean(singleVxlanDetail.isIpv6);
- builder.setSrc(TranslateUtils.arrayToIpAddress(isIpv6, singleVxlanDetail.srcAddress));
- builder.setDst(TranslateUtils.arrayToIpAddress(isIpv6, singleVxlanDetail.dstAddress));
+ final Boolean isIpv6 = byteToBoolean(singleVxlanDetail.isIpv6);
+ builder.setSrc(arrayToIpAddress(isIpv6, singleVxlanDetail.srcAddress));
+ builder.setDst(arrayToIpAddress(isIpv6, singleVxlanDetail.dstAddress));
// There are additional attributes of a vxlan tunnel that wont be used here
}
}
@@ -230,21 +266,22 @@ The '"ReaderFactory also needs to be updated:
[source,java]
----
-package io.fd.honeycomb.tutorial.read;
+package io.fd.hc2vpp.samples.read;
import com.google.inject.Inject;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
import io.fd.honeycomb.translate.impl.read.GenericListReader;
import io.fd.honeycomb.translate.read.ReaderFactory;
import io.fd.honeycomb.translate.read.registry.ModifiableReaderRegistryBuilder;
-import io.fd.honeycomb.translate.v3po.util.NamingContext;
-import javax.annotation.Nonnull;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.SamplePluginState;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.SamplePluginStateBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.sample.plugin.params.Vxlans;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.sample.plugin.params.VxlansBuilder;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.sample.plugin.params.vxlans.VxlanTunnel;
+import io.fd.vpp.jvpp.core.future.FutureJVppCore;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.SamplePluginState;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.SamplePluginStateBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.sample.plugin.params.Vxlans;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.sample.plugin.params.VxlansBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.sample.plugin.params.vxlans.VxlanTunnel;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
-import org.openvpp.jvpp.core.future.FutureJVppCore;
+
+import javax.annotation.Nonnull;
/**
* Factory producing readers for sample-plugin plugin's data.
@@ -292,26 +329,32 @@ Rename to VxlanWriteCustomizer. Update the code to:
[source,java]
----
-package io.fd.honeycomb.tutorial.write;
+package io.fd.hc2vpp.samples.write;
+
+import io.fd.hc2vpp.common.translate.util.AddressTranslator;
+import io.fd.hc2vpp.common.translate.util.ByteDataTranslator;
+import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
import io.fd.honeycomb.translate.spi.write.ListWriterCustomizer;
-import io.fd.honeycomb.translate.v3po.util.NamingContext;
-import io.fd.honeycomb.translate.v3po.util.TranslateUtils;
import io.fd.honeycomb.translate.write.WriteContext;
import io.fd.honeycomb.translate.write.WriteFailedException;
-import javax.annotation.Nonnull;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.sample.plugin.params.vxlans.VxlanTunnel;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.sample.plugin.params.vxlans.VxlanTunnelKey;
+import io.fd.vpp.jvpp.core.dto.VxlanAddDelTunnel;
+import io.fd.vpp.jvpp.core.dto.VxlanAddDelTunnelReply;
+import io.fd.vpp.jvpp.core.future.FutureJVppCore;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.sample.plugin.params.vxlans.VxlanTunnel;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.sample.plugin.params.vxlans.VxlanTunnelKey;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
-import org.openvpp.jvpp.VppBaseCallException;
-import org.openvpp.jvpp.core.dto.VxlanAddDelTunnel;
-import org.openvpp.jvpp.core.dto.VxlanAddDelTunnelReply;
-import org.openvpp.jvpp.core.future.FutureJVppCore;
+
+import javax.annotation.Nonnull;
/**
* Writer for {@link VxlanTunnel} list node from our YANG model.
*/
-public final class VxlanWriteCustomizer implements ListWriterCustomizer<VxlanTunnel, VxlanTunnelKey> {
+public final class VxlanWriteCustomizer implements ListWriterCustomizer<VxlanTunnel, VxlanTunnelKey>,
+ ByteDataTranslator,
+ AddressTranslator,
+ JvppReplyConsumer {
/**
* JVpp APIs
@@ -337,22 +380,18 @@ public final class VxlanWriteCustomizer implements ListWriterCustomizer<VxlanTun
vxlanAddDelTunnel.isAdd = 1;
// dataAfter is the new vxlanTunnel configuration
final boolean isIpv6 = dataAfter.getSrc().getIpv6Address() != null;
- vxlanAddDelTunnel.isIpv6 = TranslateUtils.booleanToByte(isIpv6);
- vxlanAddDelTunnel.srcAddress = TranslateUtils.ipAddressToArray(isIpv6, dataAfter.getSrc());
- vxlanAddDelTunnel.dstAddress = TranslateUtils.ipAddressToArray(isIpv6, dataAfter.getDst());
+ vxlanAddDelTunnel.isIpv6 = booleanToByte(isIpv6);
+ vxlanAddDelTunnel.srcAddress = ipAddressToArray(isIpv6, dataAfter.getSrc());
+ vxlanAddDelTunnel.dstAddress = ipAddressToArray(isIpv6, dataAfter.getDst());
// There are other input parameters that are not exposed by our YANG model, default values will be used
- try {
- final VxlanAddDelTunnelReply replyForWrite = TranslateUtils
- .getReplyForWrite(jvppCore.vxlanAddDelTunnel(vxlanAddDelTunnel).toCompletableFuture(), id);
- // VPP returns the index of new vxlan tunnel
- final int newVxlanTunnelIndex = replyForWrite.swIfIndex;
- // It's important to store it in context so that reader knows to which name a vxlan tunnel is mapped
- vxlanTunnelNamingContext.addName(newVxlanTunnelIndex, dataAfter.getId(), writeContext.getMappingContext());
- } catch (VppBaseCallException e) {
- throw new WriteFailedException.CreateFailedException(id, dataAfter, e);
- }
+ final VxlanAddDelTunnelReply replyForWrite = getReplyForWrite(jvppCore.vxlanAddDelTunnel(vxlanAddDelTunnel).toCompletableFuture(), id);
+
+ // VPP returns the index of new vxlan tunnel
+ final int newVxlanTunnelIndex = replyForWrite.swIfIndex;
+ // It's important to store it in context so that reader knows to which name a vxlan tunnel is mapped
+ vxlanTunnelNamingContext.addName(newVxlanTunnelIndex, dataAfter.getId(), writeContext.getMappingContext());
}
@Override
@@ -376,19 +415,14 @@ public final class VxlanWriteCustomizer implements ListWriterCustomizer<VxlanTun
// Vxlan tunnel is identified by its attributes when deleting, not index, so set all attributes
// dataBefore is the vxlan tunnel that's being deleted
final boolean isIpv6 = dataBefore.getSrc().getIpv6Address() != null;
- vxlanAddDelTunnel.isIpv6 = TranslateUtils.booleanToByte(isIpv6);
- vxlanAddDelTunnel.srcAddress = TranslateUtils.ipAddressToArray(isIpv6, dataBefore.getSrc());
- vxlanAddDelTunnel.dstAddress = TranslateUtils.ipAddressToArray(isIpv6, dataBefore.getDst());
+ vxlanAddDelTunnel.isIpv6 = booleanToByte(isIpv6);
+ vxlanAddDelTunnel.srcAddress = ipAddressToArray(isIpv6, dataBefore.getSrc());
+ vxlanAddDelTunnel.dstAddress = ipAddressToArray(isIpv6, dataBefore.getDst());
// There are other input parameters that are not exposed by our YANG model, default values will be used
- try {
- final VxlanAddDelTunnelReply replyForWrite = TranslateUtils
- .getReplyForWrite(jvppCore.vxlanAddDelTunnel(vxlanAddDelTunnel).toCompletableFuture(), id);
- // It's important to remove the mapping from context
- vxlanTunnelNamingContext.removeName(dataBefore.getId(), writeContext.getMappingContext());
- } catch (VppBaseCallException e) {
- throw new WriteFailedException.DeleteFailedException(id, e);
- }
+ final VxlanAddDelTunnelReply replyForWrite = getReplyForWrite(jvppCore.vxlanAddDelTunnel(vxlanAddDelTunnel).toCompletableFuture(), id);
+ // It's important to remove the mapping from context
+ vxlanTunnelNamingContext.removeName(dataBefore.getId(), writeContext.getMappingContext());
}
}
----
@@ -397,19 +431,19 @@ The '"WriterFactory also needs to be updated:
[source,java]
----
-package io.fd.honeycomb.tutorial.write;
+package io.fd.hc2vpp.samples.write;
import com.google.inject.Inject;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
import io.fd.honeycomb.translate.impl.write.GenericWriter;
-import io.fd.honeycomb.translate.v3po.util.NamingContext;
import io.fd.honeycomb.translate.write.WriterFactory;
import io.fd.honeycomb.translate.write.registry.ModifiableWriterRegistryBuilder;
-import javax.annotation.Nonnull;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.SamplePlugin;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.sample.plugin.params.Vxlans;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev160918.sample.plugin.params.vxlans.VxlanTunnel;
+import io.fd.vpp.jvpp.core.future.FutureJVppCore;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.SamplePlugin;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.sample.plugin.params.Vxlans;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.sample.plugin.rev161214.sample.plugin.params.vxlans.VxlanTunnel;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
-import org.openvpp.jvpp.core.future.FutureJVppCore;
+import javax.annotation.Nonnull;
/**
* Factory producing writers for sample-plugin plugin's data.
@@ -453,17 +487,15 @@ and the code needs to look like:
[source,java]
----
-package io.fd.honeycomb.tutorial;
+package io.fd.hc2vpp.samples;
import com.google.inject.AbstractModule;
import com.google.inject.multibindings.Multibinder;
-import io.fd.honeycomb.data.init.DataTreeInitializer;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
+import io.fd.hc2vpp.samples.read.ModuleStateReaderFactory;
+import io.fd.hc2vpp.samples.write.ModuleWriterFactory;
import io.fd.honeycomb.translate.read.ReaderFactory;
-import io.fd.honeycomb.translate.v3po.util.NamingContext;
import io.fd.honeycomb.translate.write.WriterFactory;
-import io.fd.honeycomb.tutorial.init.ConfigDataInitializer;
-import io.fd.honeycomb.tutorial.read.ModuleStateReaderFactory;
-import io.fd.honeycomb.tutorial.write.ModuleWriterFactory;
import net.jmob.guice.conf.core.ConfigurationModule;
/**
@@ -493,11 +525,6 @@ public final class Module extends AbstractModule {
final Multibinder<WriterFactory> writerFactoryBinder = Multibinder.newSetBinder(binder(), WriterFactory.class);
writerFactoryBinder.addBinding().to(ModuleWriterFactory.class);
- // create initializer binding
- // can hold multiple binding for separate yang modules
- final Multibinder<DataTreeInitializer> initializerBinder =
- Multibinder.newSetBinder(binder(), DataTreeInitializer.class);
- initializerBinder.addBinding().to(ConfigDataInitializer.class);
// Disable notification producer for now
// Multibinder.newSetBinder(binder(), ManagedNotificationProducer.class).addBinding()
@@ -526,32 +553,13 @@ In order to add this new plugin into vpp-integration:
</dependency>
----
-* modify Main of vpp-integration distribution to include sample-plugin (/home/mmarsale/Projects/honeycomb/vpp-integration/minimal-distribution/src/main/java/io/fd/honeycomb/vpp/integration/distro/Main.java):
-[source,java]
+* modify Modify vpp-integration-distribution pom.xml property <distribution.modules>
+[source,xml,subs="+attributes"]
----
-package io.fd.honeycomb.vpp.integration.distro;
-
-import com.google.common.collect.Lists;
-import com.google.inject.Module;
-import io.fd.honeycomb.vpp.distro.VppCommonModule;
-import java.util.List;
-
-public class Main {
-
- public static void main(String[] args) {
- final List<Module> sampleModules = Lists.newArrayList(io.fd.honeycomb.infra.distro.Main.BASE_MODULES);
-
- // All the plugins should be listed here
- sampleModules.add(new VppCommonModule());
-// Comment out V3po and Lisp module for the time being, since V3po and sample-plugin are in conflict over vxlan tunnel management
-// a plugin implementing VPP's API that's not yet covered by V3po or LISP plugin would not have to do this
-// sampleModules.add(new V3poModule());
-// sampleModules.add(new LispModule());
- sampleModules.add(new io.fd.honeycomb.tutorial.Module());
-
- io.fd.honeycomb.infra.distro.Main.init(sampleModules);
- }
-}
+ <distribution.modules>
+ some.module.full.package.name.ModuleClass,
+ io.fd.hc2vpp.samples.Module //add your plugin module class
+</distribution.modules>
----
Now just rebuild the honeycomb project.
@@ -559,24 +567,27 @@ Now just rebuild the honeycomb project.
== Verifying distribution
At this point, the vpp-integration distribution with sample-plugin can now be started. But first, make sure that a compatible version of VPP is installed and running. Next, start honeycomb with:
- sudo vpp-integration/minimal-distribution/target/vpp-integration-distribution-1.16.9-hc/vpp-integration-distribution-1.16.9/honeycomb
+[source,xml,subs="+attributes"]
+----
+sudo hc2vpp/vpp-integration/minimal-distribution/target/vpp-integration-distribution-{project-version}-hc/vpp-integration-distribution-{project-version}
+----
=== Testing over RESTCONF
Reading vxlans operational data (should return empty vxlans container at first):
- curl -u admin:admin http://localhost:8181/restconf/operational/sample-plugin:sample-plugin-state
+ curl -u admin:admin http://localhost:8183/restconf/operational/sample-plugin:sample-plugin-state
Adding a vxlan tunnel:
- curl -H 'Content-Type: application/json' -H 'Accept: application/json' -u admin:admin -X PUT -d '{"vxlans":{"vxlan-tunnel": [{"id":"vxlan-test-tunnel", "src":"10.0.0.1", "dst":"10.0.0.2"}]}}' http://localhost:8181/restconf/config/sample-plugin:sample-plugin/vxlans
+ curl -H 'Content-Type: application/json' -H 'Accept: application/json' -u admin:admin -X PUT -d '{"vxlans":{"vxlan-tunnel": [{"id":"vxlan-test-tunnel", "src":"10.0.0.1", "dst":"10.0.0.2"}]}}' http://localhost:8183/restconf/config/sample-plugin:sample-plugin/vxlans
Reading vxlans config data (data that we posted to Honeycomb):
- curl -u admin:admin http://localhost:8181/restconf/config/sample-plugin:sample-plugin
+ curl -u admin:admin http://localhost:8183/restconf/config/sample-plugin:sample-plugin
Reading vxlans operational data (data coming from VPP being transformed by ReaderCustomizer on the fly):
- curl -u admin:admin http://localhost:8181/restconf/operational/sample-plugin:sample-plugin-state
+ curl -u admin:admin http://localhost:8183/restconf/operational/sample-plugin:sample-plugin-state
Verifying vxlan tunnel existence in VPP:
@@ -594,7 +605,7 @@ vxlan_tunnel0 1 up
Deleting a vxlan tunnel:
- curl -u admin:admin -X DELETE http://localhost:8181/restconf/config/sample-plugin:sample-plugin/vxlans/vxlan-tunnel/vxlan-test-tunnel
+ curl -u admin:admin -X DELETE http://localhost:8183/restconf/config/sample-plugin:sample-plugin/vxlans/vxlan-tunnel/vxlan-test-tunnel
Disclaimer: The vxlan tunnel will be removed from Honeycomb, and delete command will be executed on VPP, but VPP will just disable that interface and keep it as some sort of placeholder for next vxlan tunnel (that's VPPs behavior, so a vxlan tunnel cant be really deleted). So that's why you would still see the tunnel in VPP's CLI after delete.